Skip to content

Latest commit

 

History

History
1403 lines (1084 loc) · 66.6 KB

UserGroupsApi.md

File metadata and controls

1403 lines (1084 loc) · 66.6 KB

UserGroupsApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
graphUserGroupAssociationsList GET /usergroups/{group_id}/associations List the associations of a User Group.
graphUserGroupAssociationsPost POST /usergroups/{group_id}/associations Manage the associations of a User Group
graphUserGroupMemberOf GET /usergroups/{group_id}/memberof List the User Group's parents
graphUserGroupMembersList GET /usergroups/{group_id}/members List the members of a User Group
graphUserGroupMembersPost POST /usergroups/{group_id}/members Manage the members of a User Group
graphUserGroupMembership GET /usergroups/{group_id}/membership List the User Group's membership
graphUserGroupTraverseActiveDirectory GET /usergroups/{group_id}/activedirectories List the Active Directories bound to a User Group
graphUserGroupTraverseApplication GET /usergroups/{group_id}/applications List the Applications bound to a User Group
graphUserGroupTraverseDirectory GET /usergroups/{group_id}/directories List the Directories bound to a User Group
graphUserGroupTraverseGSuite GET /usergroups/{group_id}/gsuites List the G Suite instances bound to a User Group
graphUserGroupTraverseLdapServer GET /usergroups/{group_id}/ldapservers List the LDAP Servers bound to a User Group
graphUserGroupTraverseOffice365 GET /usergroups/{group_id}/office365s List the Office 365 instances bound to a User Group
graphUserGroupTraverseRadiusServer GET /usergroups/{group_id}/radiusservers List the RADIUS Servers bound to a User Group
graphUserGroupTraverseSystem GET /usergroups/{group_id}/systems List the Systems bound to a User Group
graphUserGroupTraverseSystemGroup GET /usergroups/{group_id}/systemgroups List the System Groups bound to User Groups
groupsUserDelete DELETE /usergroups/{id} Delete a User Group
groupsUserGet GET /usergroups/{id} View an individual User Group details
groupsUserList GET /usergroups List all User Groups
groupsUserPatch PATCH /usergroups/{id} Partial update a User Group
groupsUserPost POST /usergroups Create a new User Group
groupsUserPut PUT /usergroups/{id} Update a User Group

graphUserGroupAssociationsList

List<GraphConnection> graphUserGroupAssociationsList(groupId, contentType, accept, targets, limit, skip, xOrgId)

List the associations of a User Group.

This endpoint returns the direct associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets&#x3D;system \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
List<String> targets = Arrays.asList("targets_example"); // List<String> | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
String xOrgId = ""; // String | 
try {
    List<GraphConnection> result = apiInstance.graphUserGroupAssociationsList(groupId, contentType, accept, targets, limit, skip, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupAssociationsList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
targets List<String> [enum: active_directory, application, command, g_suite, ldap_server, office_365, policy, radius_server, system, system_group]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
xOrgId String [optional] [default to ]

Return type

List<GraphConnection>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupAssociationsPost

graphUserGroupAssociationsPost(groupId, contentType, accept, body, xOrgId)

Manage the associations of a User Group

This endpoint manages the direct associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ &quot;op&quot;: &quot;add&quot;, &quot;type&quot;: &quot;system&quot;, &quot;id&quot;: &quot;{SystemID}&quot; }' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
UserGroupGraphManagementReq body = new UserGroupGraphManagementReq(); // UserGroupGraphManagementReq | 
String xOrgId = ""; // String | 
try {
    apiInstance.graphUserGroupAssociationsPost(groupId, contentType, accept, body, xOrgId);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupAssociationsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
body UserGroupGraphManagementReq [optional]
xOrgId String [optional] [default to ]

Return type

null (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupMemberOf

List<GraphObjectWithPaths> graphUserGroupMemberOf(groupId, contentType, accept, filter, limit, skip, sort, xOrgId)

List the User Group's parents

This endpoint returns all User Groups a User Group is a member of. #### Sample Request ``` https://console.jumpcloud.com/api/v2/usergroups/{group_id}/memberof ``` Not public yet, as the code is not finished,

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
List<String> sort = Arrays.asList("sort_example"); // List<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
String xOrgId = ""; // String | 
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupMemberOf(groupId, contentType, accept, filter, limit, skip, sort, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupMemberOf");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
sort List<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
xOrgId String [optional] [default to ]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupMembersList

List<GraphConnection> graphUserGroupMembersList(groupId, contentType, accept, limit, skip, xOrgId)

List the members of a User Group

This endpoint returns the user members of a User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
String xOrgId = ""; // String | 
try {
    List<GraphConnection> result = apiInstance.graphUserGroupMembersList(groupId, contentType, accept, limit, skip, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupMembersList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
xOrgId String [optional] [default to ]

Return type

List<GraphConnection>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupMembersPost

graphUserGroupMembersPost(groupId, contentType, accept, body, xOrgId)

Manage the members of a User Group

This endpoint allows you to manage the user members of a User Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ &quot;op&quot;: &quot;add&quot;, &quot;type&quot;: &quot;user&quot;, &quot;id&quot;: &quot;{User_ID}&quot; }' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
UserGroupMembersReq body = new UserGroupMembersReq(); // UserGroupMembersReq | 
String xOrgId = ""; // String | 
try {
    apiInstance.graphUserGroupMembersPost(groupId, contentType, accept, body, xOrgId);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupMembersPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
body UserGroupMembersReq [optional]
xOrgId String [optional] [default to ]

Return type

null (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupMembership

List<GraphObjectWithPaths> graphUserGroupMembership(groupId, contentType, accept, filter, limit, skip, sort, xOrgId)

List the User Group's membership

This endpoint returns all users members that are a member of this User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
List<String> sort = Arrays.asList("sort_example"); // List<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
String xOrgId = ""; // String | 
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupMembership(groupId, contentType, accept, filter, limit, skip, sort, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupMembership");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
sort List<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
xOrgId String [optional] [default to ]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseActiveDirectory

List<GraphObjectWithPaths> graphUserGroupTraverseActiveDirectory(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the Active Directories bound to a User Group

This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseActiveDirectory(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseActiveDirectory");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseApplication

List<GraphObjectWithPaths> graphUserGroupTraverseApplication(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the Applications bound to a User Group

This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseApplication(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseApplication");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseDirectory

List<GraphObjectWithPaths> graphUserGroupTraverseDirectory(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the Directories bound to a User Group

This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseDirectory(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseDirectory");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseGSuite

List<GraphObjectWithPaths> graphUserGroupTraverseGSuite(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the G Suite instances bound to a User Group

This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseGSuite(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseGSuite");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseLdapServer

List<GraphObjectWithPaths> graphUserGroupTraverseLdapServer(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the LDAP Servers bound to a User Group

This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseLdapServer(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseLdapServer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseOffice365

List<GraphObjectWithPaths> graphUserGroupTraverseOffice365(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the Office 365 instances bound to a User Group

This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseOffice365(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseOffice365");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseRadiusServer

List<GraphObjectWithPaths> graphUserGroupTraverseRadiusServer(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the RADIUS Servers bound to a User Group

This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseRadiusServer(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseRadiusServer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseSystem

List<GraphObjectWithPaths> graphUserGroupTraverseSystem(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the Systems bound to a User Group

This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseSystem(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseSystem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graphUserGroupTraverseSystemGroup

List<GraphObjectWithPaths> graphUserGroupTraverseSystemGroup(groupId, contentType, accept, limit, xOrgId, skip, filter)

List the System Groups bound to User Groups

This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String groupId = "groupId_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String xOrgId = ""; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
try {
    List<GraphObjectWithPaths> result = apiInstance.graphUserGroupTraverseSystemGroup(groupId, contentType, accept, limit, xOrgId, skip, filter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#graphUserGroupTraverseSystemGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupId String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
xOrgId String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

List<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserDelete

groupsUserDelete(id, contentType, accept, xOrgId)

Delete a User Group

This endpoint allows you to delete a User Group. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String id = "id_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
String xOrgId = ""; // String | 
try {
    apiInstance.groupsUserDelete(id, contentType, accept, xOrgId);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
xOrgId String [optional] [default to ]

Return type

null (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserGet

UserGroup groupsUserGet(id, contentType, accept, xOrgId)

View an individual User Group details

This endpoint returns the details of a User Group. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String id = "id_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
String xOrgId = ""; // String | 
try {
    UserGroup result = apiInstance.groupsUserGet(id, contentType, accept, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
xOrgId String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserList

List<UserGroup> groupsUserList(contentType, accept, fields, filter, limit, skip, sort, xOrgId)

List all User Groups

This endpoint returns all User Groups. Available filter fields: - `name` - `disabled` - `type` #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
List<String> fields = Arrays.asList("fields_example"); // List<String> | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. 
List<String> filter = Arrays.asList("filter_example"); // List<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
List<String> sort = Arrays.asList("sort_example"); // List<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
String xOrgId = ""; // String | 
try {
    List<UserGroup> result = apiInstance.groupsUserList(contentType, accept, fields, filter, limit, skip, sort, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contentType String [default to application/json]
accept String [default to application/json]
fields List<String> The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. [optional]
filter List<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
limit Integer The number of records to return at once. Limited to 100. [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
sort List<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
xOrgId String [optional] [default to ]

Return type

List<UserGroup>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserPatch

UserGroup groupsUserPatch(id, contentType, accept, body, xOrgId)

Partial update a User Group

We have hidden PATCH on the systemgroups and usergroups for now; we don't have that implemented correctly yet, people should use PUT until we do a true PATCH operation. #### Sample Request ``` https://console.jumpcloud.com/api/v2/usergroups/{id} ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String id = "id_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
UserGroupPost body = new UserGroupPost(); // UserGroupPost | 
String xOrgId = ""; // String | 
try {
    UserGroup result = apiInstance.groupsUserPatch(id, contentType, accept, body, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserPatch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
body UserGroupPost [optional]
xOrgId String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserPost

UserGroup groupsUserPost(contentType, accept, body, xOrgId)

Create a new User Group

This endpoint allows you to create a new User Group. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/usergroups \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ &quot;name&quot;: &quot;{Group_Name}&quot; }' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
UserGroupPost body = new UserGroupPost(); // UserGroupPost | 
String xOrgId = ""; // String | 
try {
    UserGroup result = apiInstance.groupsUserPost(contentType, accept, body, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
contentType String [default to application/json]
accept String [default to application/json]
body UserGroupPost [optional]
xOrgId String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groupsUserPut

UserGroup groupsUserPut(id, contentType, accept, body, xOrgId)

Update a User Group

This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY' \ -d '{ &quot;name&quot;: &quot;group_update&quot; }' ```

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UserGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

UserGroupsApi apiInstance = new UserGroupsApi();
String id = "id_example"; // String | ObjectID of the User Group.
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
UserGroupPut body = new UserGroupPut(); // UserGroupPut | 
String xOrgId = ""; // String | 
try {
    UserGroup result = apiInstance.groupsUserPut(id, contentType, accept, body, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserGroupsApi#groupsUserPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
contentType String [default to application/json]
accept String [default to application/json]
body UserGroupPut [optional]
xOrgId String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json