Skip to content

Latest commit

 

History

History
189 lines (133 loc) · 8.92 KB

SystemGroupMembersMembershipApi.md

File metadata and controls

189 lines (133 loc) · 8.92 KB

\SystemGroupMembersMembershipApi

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

Method HTTP request Description
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

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]