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

Latest commit

 

History

History
1043 lines (740 loc) · 38.3 KB

SystemGroupsApi.md

File metadata and controls

1043 lines (740 loc) · 38.3 KB

JCAPIv2::SystemGroupsApi

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

Method HTTP request Description
graph_system_group_associations_list GET /systemgroups/{group_id}/associations List the associations of a System Group
graph_system_group_associations_post POST /systemgroups/{group_id}/associations Manage the associations of a System Group
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_traverse_policy GET /systemgroups/{group_id}/policies List the Policies bound to a System Group
graph_system_group_traverse_user GET /systemgroups/{group_id}/users List the Users bound to a System Group
graph_system_group_traverse_user_group GET /systemgroups/{group_id}/usergroups List the User Groups bound to a System Group
groups_system_delete DELETE /systemgroups/{id} Delete a System Group
groups_system_get GET /systemgroups/{id} View an individual System Group details
groups_system_list GET /systemgroups List all System Groups
groups_system_patch PATCH /systemgroups/{id} Partial update a System Group
groups_system_post POST /systemgroups Create a new System Group
groups_system_put PUT /systemgroups/{id} Update a System Group

graph_system_group_associations_list

Array<GraphConnection> graph_system_group_associations_list(group_id, content_type, accepttargets, opts)

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

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::SystemGroupsApi.new

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

content_type = "application/json" # String | 

accept = "application/json" # String | 

targets = ["targets_example"] # Array<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 associations of a System Group
  result = api_instance.graph_system_group_associations_list(group_id, content_type, accepttargets, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->graph_system_group_associations_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]
targets Array<String>
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_associations_post

graph_system_group_associations_post(group_id, content_type, accept, opts)

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

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::SystemGroupsApi.new

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

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::SystemGroupGraphManagementReq.new, # SystemGroupGraphManagementReq | 
  x_org_id: "" # String | 
}

begin
  #Manage the associations of a System Group
  api_instance.graph_system_group_associations_post(group_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->graph_system_group_associations_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 SystemGroupGraphManagementReq [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_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::SystemGroupsApi.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 SystemGroupsApi->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::SystemGroupsApi.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 SystemGroupsApi->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::SystemGroupsApi.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 SystemGroupsApi->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::SystemGroupsApi.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 SystemGroupsApi->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

graph_system_group_traverse_policy

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

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

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::SystemGroupsApi.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.
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
}

begin
  #List the Policies bound to a System Group
  result = api_instance.graph_system_group_traverse_policy(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->graph_system_group_traverse_policy: #{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]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

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

graph_system_group_traverse_user

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

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

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::SystemGroupsApi.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.
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
}

begin
  #List the Users bound to a System Group
  result = api_instance.graph_system_group_traverse_user(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->graph_system_group_traverse_user: #{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]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

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

graph_system_group_traverse_user_group

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

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

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::SystemGroupsApi.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.
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
}

begin
  #List the User Groups bound to a System Group
  result = api_instance.graph_system_group_traverse_user_group(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->graph_system_group_traverse_user_group: #{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]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

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

groups_system_delete

groups_system_delete(id, content_type, accept, opts)

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

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::SystemGroupsApi.new

id = "id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Delete a System Group
  api_instance.groups_system_delete(id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_delete: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
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

groups_system_get

SystemGroup groups_system_get(id, content_type, accept, opts)

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

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::SystemGroupsApi.new

id = "id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #View an individual System Group details
  result = api_instance.groups_system_get(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_get: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
x_org_id String [optional] [default to ]

Return type

SystemGroup

Authorization

x-api-key

HTTP request headers

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

groups_system_list

Array<SystemGroup> groups_system_list(content_type, accept, opts)

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

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::SystemGroupsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  fields: ["fields_example"], # Array<String> | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. 
  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 all System Groups
  result = api_instance.groups_system_list(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_list: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
fields Array<String> The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. [optional]
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<SystemGroup>

Authorization

x-api-key

HTTP request headers

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

groups_system_patch

SystemGroup groups_system_patch(id, content_type, accept, opts)

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}

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::SystemGroupsApi.new

id = "id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::SystemGroupData.new, # SystemGroupData | 
  x_org_id: "" # String | 
}

begin
  #Partial update a System Group
  result = api_instance.groups_system_patch(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_patch: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
body SystemGroupData [optional]
x_org_id String [optional] [default to ]

Return type

SystemGroup

Authorization

x-api-key

HTTP request headers

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

groups_system_post

SystemGroup groups_system_post(content_type, accept, opts)

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

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::SystemGroupsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::SystemGroupData.new, # SystemGroupData | 
  x_org_id: "" # String | 
}

begin
  #Create a new System Group
  result = api_instance.groups_system_post(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_post: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
body SystemGroupData [optional]
x_org_id String [optional] [default to ]

Return type

SystemGroup

Authorization

x-api-key

HTTP request headers

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

groups_system_put

SystemGroup groups_system_put(id, content_type, accept, opts)

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

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::SystemGroupsApi.new

id = "id_example" # String | ObjectID of the System Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::SystemGroupData.new, # SystemGroupData | 
  x_org_id: "" # String | 
}

begin
  #Update a System Group
  result = api_instance.groups_system_put(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemGroupsApi->groups_system_put: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the System Group.
content_type String [default to application/json]
accept String [default to application/json]
body SystemGroupData [optional]
x_org_id String [optional] [default to ]

Return type

SystemGroup

Authorization

x-api-key

HTTP request headers

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