Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
293 lines (209 loc) · 11.1 KB

SystemGroupMembersMembershipApi.md

File metadata and controls

293 lines (209 loc) · 11.1 KB

JCAPIv2::SystemGroupMembersMembershipApi

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

Method HTTP request Description
graph_system_group_member_of GET /systemgroups/{group_id}/memberof List the System Group's parents
graph_system_group_members_list GET /systemgroups/{group_id}/members List the members of a System Group
graph_system_group_members_post POST /systemgroups/{group_id}/members Manage the members of a System Group
graph_system_group_membership GET /systemgroups/{group_id}/membership List the System Group's membership

graph_system_group_member_of

Array<GraphObjectWithPaths> graph_system_group_member_of(group_id, content_type, accept, opts)

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.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemGroupMembersMembershipApi.new

group_id = "group_id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  x_org_id: "" # String | 
}

begin
  #List the System Group's parents
  result = api_instance.graph_system_group_member_of(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupMembersMembershipApi->graph_system_group_member_of: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
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]
sort Array<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
x_org_id String [optional] [default to ]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

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

graph_system_group_members_list

Array<GraphConnection> graph_system_group_members_list(group_id, content_type, accept, opts)

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}'

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemGroupMembersMembershipApi.new

group_id = "group_id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  x_org_id: "" # String | 
}

begin
  #List the members of a System Group
  result = api_instance.graph_system_group_members_list(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupMembersMembershipApi->graph_system_group_members_list: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the System Group.
content_type 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]
x_org_id String [optional] [default to ]

Return type

Array<GraphConnection>

Authorization

x-api-key

HTTP request headers

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

graph_system_group_members_post

graph_system_group_members_post(group_id, content_type, accept, opts)

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}\" }'

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemGroupMembersMembershipApi.new

group_id = "group_id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::SystemGroupMembersReq.new, # SystemGroupMembersReq | 
  date: "date_example", # String | Current date header for the System Context API
  authorization: "authorization_example", # String | Authorization header for the System Context API
  x_org_id: "" # String | 
}

begin
  #Manage the members of a System Group
  api_instance.graph_system_group_members_post(group_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupMembersMembershipApi->graph_system_group_members_post: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
body SystemGroupMembersReq [optional]
date String Current date header for the System Context API [optional]
authorization String Authorization header for the System Context API [optional]
x_org_id String [optional] [default to ]

Return type

nil (empty response body)

Authorization

x-api-key

HTTP request headers

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

graph_system_group_membership

Array<GraphObjectWithPaths> graph_system_group_membership(group_id, content_type, accept, opts)

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}'

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemGroupMembersMembershipApi.new

group_id = "group_id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  x_org_id: "" # String | 
}

begin
  #List the System Group's membership
  result = api_instance.graph_system_group_membership(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupMembersMembershipApi->graph_system_group_membership: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the System Group.
content_type 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]
sort Array<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
x_org_id String [optional] [default to ]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

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