All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| graphApplicationAssociationsList | GET /applications/{application_id}/associations | List the associations of an Application |
| graphApplicationAssociationsPost | POST /applications/{application_id}/associations | Manage the associations of an Application |
| graphApplicationTraverseUser | GET /applications/{application_id}/users | List the Users bound to an Application |
| graphApplicationTraverseUserGroup | GET /applications/{application_id}/usergroups | List the User Groups bound to an Application |
List<GraphConnection> graphApplicationAssociationsList(applicationId, targets, contentType, accept, limit, skip, xOrgId)
List the associations of an Application
This endpoint will return the direct associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. #### Sample Request ``` curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
// 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.ApplicationsApi;
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");
ApplicationsApi apiInstance = new ApplicationsApi();
String applicationId = "applicationId_example"; // String | ObjectID of the Application.
List<String> targets = Arrays.asList("targets_example"); // List<String> |
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.graphApplicationAssociationsList(applicationId, targets, contentType, accept, limit, skip, xOrgId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationsApi#graphApplicationAssociationsList");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | ObjectID of the Application. | |
| targets | List<String> | [enum: active_directory, application, command, g_suite, ldap_server, office_365, policy, radius_server, system, system_group, user, 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 ] |
- Content-Type: application/json
- Accept: application/json
graphApplicationAssociationsPost(applicationId, contentType, accept, body, xOrgId)
Manage the associations of an Application
This endpoint allows you to manage the direct associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. #### Sample Request ``` curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "op": "add", "type": "user_group", "id": "{Group_ID}" }' ```
// 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.ApplicationsApi;
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");
ApplicationsApi apiInstance = new ApplicationsApi();
String applicationId = "applicationId_example"; // String | ObjectID of the Application.
String contentType = "application/json"; // String |
String accept = "application/json"; // String |
GraphManagementReq body = new GraphManagementReq(); // GraphManagementReq |
String xOrgId = ""; // String |
try {
apiInstance.graphApplicationAssociationsPost(applicationId, contentType, accept, body, xOrgId);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationsApi#graphApplicationAssociationsPost");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | ObjectID of the Application. | |
| contentType | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| body | GraphManagementReq | [optional] | |
| xOrgId | String | [optional] [default to ] |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
List<GraphObjectWithPaths> graphApplicationTraverseUser(applicationId, contentType, accept, limit, xOrgId, skip, filter)
List the Users bound to an Application
This endpoint will return all Users bound to an Application, 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 Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
// 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.ApplicationsApi;
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");
ApplicationsApi apiInstance = new ApplicationsApi();
String applicationId = "applicationId_example"; // String | ObjectID of the Application.
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.graphApplicationTraverseUser(applicationId, contentType, accept, limit, xOrgId, skip, filter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationsApi#graphApplicationTraverseUser");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | ObjectID of the Application. | |
| 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] |
- Content-Type: application/json
- Accept: application/json
List<GraphObjectWithPaths> graphApplicationTraverseUserGroup(applicationId, contentType, accept, limit, xOrgId, skip, filter)
List the User Groups bound to an Application
This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's 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 Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ```
// 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.ApplicationsApi;
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");
ApplicationsApi apiInstance = new ApplicationsApi();
String applicationId = "applicationId_example"; // String | ObjectID of the Application.
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.graphApplicationTraverseUserGroup(applicationId, contentType, accept, limit, xOrgId, skip, filter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApplicationsApi#graphApplicationTraverseUserGroup");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | ObjectID of the Application. | |
| 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] |
- Content-Type: application/json
- Accept: application/json