All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| graph_command_associations_list | GET /commands/{command_id}/associations | List the associations of a Command |
| graph_command_associations_post | POST /commands/{command_id}/associations | Manage the associations of a Command |
| graph_command_traverse_system | GET /commands/{command_id}/systems | List the Systems bound to a Command |
| graph_command_traverse_system_group | GET /commands/{command_id}/systemgroups | List the System Groups bound to a Command |
Array<GraphConnection> graph_command_associations_list(command_id, targets, content_type, accept, opts)
List the associations of a Command
This endpoint will return the direct associations of this Command. A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
# 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::CommandsApi.new
command_id = "command_id_example" # String | ObjectID of the Command.
targets = ["targets_example"] # Array<String> |
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 associations of a Command
result = api_instance.graph_command_associations_list(command_id, targets, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling CommandsApi->graph_command_associations_list: #{e}"
end
| Name | Type | Description | Notes |
|---|---|---|---|
| command_id | String | ObjectID of the Command. | |
| targets | Array<String> | ||
| 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 ] |
- Content-Type: application/json
- Accept: application/json
graph_command_associations_post(command_id, content_type, accept, opts)
Manage the associations of a Command
This endpoint will allow you to manage the direct associations of this Command. A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"system_group\", \"id\": \"Group_ID\" }'
# 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::CommandsApi.new
command_id = "command_id_example" # String | ObjectID of the Command.
content_type = "application/json" # String |
accept = "application/json" # String |
opts = {
body: JCAPIv2::GraphManagementReq.new, # GraphManagementReq |
x_org_id: "" # String |
}
begin
#Manage the associations of a Command
api_instance.graph_command_associations_post(command_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
puts "Exception when calling CommandsApi->graph_command_associations_post: #{e}"
end
| Name | Type | Description | Notes |
|---|---|---|---|
| command_id | String | ObjectID of the Command. | |
| content_type | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| body | GraphManagementReq | [optional] | |
| x_org_id | String | [optional] [default to ] |
nil (empty response body)
- Content-Type: application/json
- Accept: application/json
Array<GraphObjectWithPaths> graph_command_traverse_system(command_id, content_type, accept, opts)
List the Systems bound to a Command
This endpoint will return all Systems bound to a Command, 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 Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
# 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::CommandsApi.new
command_id = "command_id_example" # String | ObjectID of the Command.
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 Systems bound to a Command
result = api_instance.graph_command_traverse_system(command_id, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling CommandsApi->graph_command_traverse_system: #{e}"
end
| Name | Type | Description | Notes |
|---|---|---|---|
| command_id | String | ObjectID of the Command. | |
| 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] |
- Content-Type: application/json
- Accept: application/json
Array<GraphObjectWithPaths> graph_command_traverse_system_group(command_id, content_type, accept, opts)
List the System Groups bound to a Command
This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's 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 Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
# 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::CommandsApi.new
command_id = "command_id_example" # String | ObjectID of the Command.
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 System Groups bound to a Command
result = api_instance.graph_command_traverse_system_group(command_id, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling CommandsApi->graph_command_traverse_system_group: #{e}"
end
| Name | Type | Description | Notes |
|---|---|---|---|
| command_id | String | ObjectID of the Command. | |
| 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] |
- Content-Type: application/json
- Accept: application/json