Skip to content

Latest commit

 

History

History
187 lines (131 loc) · 10.2 KB

ApplicationsApi.md

File metadata and controls

187 lines (131 loc) · 10.2 KB

\ApplicationsApi

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

GraphApplicationAssociationsList

[]GraphConnection GraphApplicationAssociationsList(ctx, applicationId, targets, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
applicationId string ObjectID of the Application.
targets []string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
applicationId string ObjectID of the Application.
targets []string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]GraphConnection

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphApplicationAssociationsPost

GraphApplicationAssociationsPost(ctx, applicationId, contentType, accept, optional) 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}\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
body GraphManagementReq
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphApplicationTraverseUser

[]GraphObjectWithPaths GraphApplicationTraverseUser(ctx, applicationId, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
xOrgId string [default to ]
skip int32 The offset into the records to return. [default to 0]
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in

Return type

[]GraphObjectWithPaths

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphApplicationTraverseUserGroup

[]GraphObjectWithPaths GraphApplicationTraverseUserGroup(ctx, applicationId, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
applicationId string ObjectID of the Application.
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
xOrgId string [default to ]
skip int32 The offset into the records to return. [default to 0]
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in

Return type

[]GraphObjectWithPaths

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]