Skip to content

Latest commit

 

History

History
187 lines (131 loc) · 8.73 KB

UserGroupMembersMembershipApi.md

File metadata and controls

187 lines (131 loc) · 8.73 KB

\UserGroupMembersMembershipApi

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

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

GraphUserGroupMemberOf

[]GraphObjectWithPaths GraphUserGroupMemberOf(ctx, groupId, contentType, accept, optional) 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,

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the User 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 User 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]

GraphUserGroupMembersList

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

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the User 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 User 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]

GraphUserGroupMembersPost

GraphUserGroupMembersPost(ctx, groupId, contentType, accept, optional) 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 '{ \"op\": \"add\", \"type\": \"user\", \"id\": \"{User_ID}\" }'

Required Parameters

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

GraphUserGroupMembership

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

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupId string ObjectID of the User 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 User 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]