Skip to content

Latest commit

 

History

History
666 lines (467 loc) · 32.3 KB

SystemGroupsApi.md

File metadata and controls

666 lines (467 loc) · 32.3 KB

\SystemGroupsApi

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

Method HTTP request Description
GraphSystemGroupAssociationsList Get /systemgroups/{group_id}/associations List the associations of a System Group
GraphSystemGroupAssociationsPost Post /systemgroups/{group_id}/associations Manage the associations of a System Group
GraphSystemGroupMemberOf Get /systemgroups/{group_id}/memberof List the System Group's parents
GraphSystemGroupMembersList Get /systemgroups/{group_id}/members List the members of a System Group
GraphSystemGroupMembersPost Post /systemgroups/{group_id}/members Manage the members of a System Group
GraphSystemGroupMembership Get /systemgroups/{group_id}/membership List the System Group's membership
GraphSystemGroupTraversePolicy Get /systemgroups/{group_id}/policies List the Policies bound to a System Group
GraphSystemGroupTraverseUser Get /systemgroups/{group_id}/users List the Users bound to a System Group
GraphSystemGroupTraverseUserGroup Get /systemgroups/{group_id}/usergroups List the User Groups bound to a System Group
GroupsSystemDelete Delete /systemgroups/{id} Delete a System Group
GroupsSystemGet Get /systemgroups/{id} View an individual System Group details
GroupsSystemList Get /systemgroups List all System Groups
GroupsSystemPatch Patch /systemgroups/{id} Partial update a System Group
GroupsSystemPost Post /systemgroups Create a new System Group
GroupsSystemPut Put /systemgroups/{id} Update a System Group

GraphSystemGroupAssociationsList

[]GraphConnection GraphSystemGroupAssociationsList(ctx, groupId, contentType, accept, targets, optional) List the associations of a System Group

This endpoint returns the direct associations of a System Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ -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.
groupId string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
targets []string
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
groupId string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
targets []string
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]

GraphSystemGroupAssociationsPost

GraphSystemGroupAssociationsPost(ctx, groupId, contentType, accept, optional) Manage the associations of a System Group

This endpoint allows you to manage the direct associations of a System Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"user\", \"id\": \"{UserID}\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
body SystemGroupGraphManagementReq
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]

GraphSystemGroupMemberOf

[]GraphObjectWithPaths GraphSystemGroupMemberOf(ctx, groupId, contentType, accept, optional) List the System Group's parents

This endpoint returns all System Groups a System Group is a member of. This endpoint is not yet public as we haven't completed the code yet.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
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]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
xOrgId string [default to ]

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]

GraphSystemGroupMembersList

[]GraphConnection GraphSystemGroupMembersList(ctx, groupId, contentType, accept, optional) List the members of a System Group

This endpoint returns the system members of a System Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ -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.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
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]

GraphSystemGroupMembersPost

GraphSystemGroupMembersPost(ctx, groupId, contentType, accept, optional) Manage the members of a System Group

This endpoint allows you to manage the system members of a System Group. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"system\", \"id\": \"{System_ID}\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
body SystemGroupMembersReq
date string Current date header for the System Context API
authorization string Authorization header for the System Context API
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]

GraphSystemGroupMembership

[]GraphObjectWithPaths GraphSystemGroupMembership(ctx, groupId, contentType, accept, optional) List the System Group's membership

This endpoint returns all Systems that are a member of this System Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ -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.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
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]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
xOrgId string [default to ]

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]

GraphSystemGroupTraversePolicy

[]GraphObjectWithPaths GraphSystemGroupTraversePolicy(ctx, groupId, contentType, accept, optional) List the Policies bound to a System Group

This endpoint will return all Policies bound to a System 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 System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. See /members and /associations endpoints to manage those collections. This endpoint is not public yet as we haven't finished the code. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ -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.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
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

[]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]

GraphSystemGroupTraverseUser

[]GraphObjectWithPaths GraphSystemGroupTraverseUser(ctx, groupId, contentType, accept, optional) List the Users bound to a System Group

This endpoint will return all Users bound to a System 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 System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/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.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
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

[]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]

GraphSystemGroupTraverseUserGroup

[]GraphObjectWithPaths GraphSystemGroupTraverseUserGroup(ctx, groupId, contentType, accept, optional) List the User Groups bound to a System Group

This endpoint will return all User Groups bound to a System 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 System Group 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 System Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/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.
groupId string ObjectID of the System Group.
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
groupId string ObjectID of the System Group.
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

[]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]

GroupsSystemDelete

GroupsSystemDelete(ctx, id, contentType, accept, optional) Delete a System Group

This endpoint allows you to delete a System Group. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ -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.
id string ObjectID of the System Group.
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
id string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
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]

GroupsSystemGet

SystemGroup GroupsSystemGet(ctx, id, contentType, accept, optional) View an individual System Group details

This endpoint returns the details of a System Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ -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.
id string ObjectID of the System Group.
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
id string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

SystemGroup

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]

GroupsSystemList

[]SystemGroup GroupsSystemList(ctx, contentType, accept, optional) List all System Groups

This endpoint returns all System Groups. Available filter fields: - name - disabled - type #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/systemgroups \\ -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.
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
contentType string [default to application/json]
accept string [default to application/json]
fields []string The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
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]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
xOrgId string [default to ]

Return type

[]SystemGroup

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]

GroupsSystemPatch

SystemGroup GroupsSystemPatch(ctx, id, contentType, accept, optional) Partial update a System 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/systemgroups/{id}

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string ObjectID of the System Group.
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
id string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
body SystemGroupData
xOrgId string [default to ]

Return type

SystemGroup

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]

GroupsSystemPost

SystemGroup GroupsSystemPost(ctx, contentType, accept, optional) Create a new System Group

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

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
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
contentType string [default to application/json]
accept string [default to application/json]
body SystemGroupData
xOrgId string [default to ]

Return type

SystemGroup

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]

GroupsSystemPut

SystemGroup GroupsSystemPut(ctx, id, contentType, accept, optional) Update a System Group

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

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string ObjectID of the System Group.
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
id string ObjectID of the System Group.
contentType string [default to application/json]
accept string [default to application/json]
body SystemGroupData
xOrgId string [default to ]

Return type

SystemGroup

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]