JCAPIv2::ActiveDirectoryApi

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

Method	HTTP request	Description
activedirectories_agents_delete	DELETE /activedirectories/{activedirectory_id}/agents/{agent_id}	Delete Active Directory Agent
activedirectories_agents_get	GET /activedirectories/{activedirectory_id}/agents/{agent_id}	Get Active Directory Agent
activedirectories_agents_list	GET /activedirectories/{activedirectory_id}/agents	List Active Directory Agents
activedirectories_agents_post	POST /activedirectories/{activedirectory_id}/agents	Create a new Active Directory Agent
activedirectories_delete	DELETE /activedirectories/{id}	Delete an Active Directory
activedirectories_get	GET /activedirectories/{id}	Get an Active Directory
activedirectories_list	GET /activedirectories	List Active Directories
activedirectories_post	POST /activedirectories	Create a new Active Directory
graph_active_directory_associations_list	GET /activedirectories/{activedirectory_id}/associations	List the associations of an Active Directory instance
graph_active_directory_associations_post	POST /activedirectories/{activedirectory_id}/associations	Manage the associations of an Active Directory instance
graph_active_directory_traverse_user_group	GET /activedirectories/{activedirectory_id}/usergroups	List the User Groups bound to an Active Directory instance

activedirectories_agents_delete

activedirectories_agents_delete(activedirectory_id, agent_id, content_type, accept, opts)

Delete Active Directory Agent

Example

# load the gem
require 'jcapiv2'

api_instance = JCAPIv2::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # String | 

agent_id = "agent_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Delete Active Directory Agent
  api_instance.activedirectories_agents_delete(activedirectory_id, agent_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_agents_delete: #{e}"
end

Parameters

Name	Type	Notes
activedirectory_id	String
agent_id	String
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

No authorization required

HTTP request headers

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

activedirectories_agents_get

ActiveDirectoryAgentListOutput activedirectories_agents_get(activedirectory_id, agent_id, content_type, accept, opts)

Get Active Directory Agent

This endpoint returns a specific active directory agent. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# load the gem
require 'jcapiv2'

api_instance = JCAPIv2::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # String | 

agent_id = "agent_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Get Active Directory Agent
  result = api_instance.activedirectories_agents_get(activedirectory_id, agent_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_agents_get: #{e}"
end

Parameters

Name	Type	Notes
activedirectory_id	String
agent_id	String
content_type	String	[default to application/json]
accept	String	[default to application/json]
x_org_id	String	[optional] [default to ]

Return type

ActiveDirectoryAgentListOutput

Authorization

No authorization required

HTTP request headers

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

activedirectories_agents_list

Array<ActiveDirectoryAgentListOutput> activedirectories_agents_list(activedirectory_id, content_type, accept, opts)

List Active Directory Agents

This endpoint allows you to list all your Active Directory Agents for a given Instance. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ -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::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # 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.
  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 Active Directory Agents
  result = api_instance.activedirectories_agents_list(activedirectory_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_agents_list: #{e}"
end

Parameters

Name	Type	Description	Notes
activedirectory_id	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]
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<ActiveDirectoryAgentListOutput>

Authorization

x-api-key

HTTP request headers

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

activedirectories_agents_post

ActiveDirectoryAgentGetOutput activedirectories_agents_post(activedirectory_id, content_type, accept, opts)

Create a new Active Directory Agent

This endpoint allows you to create a new Active Directory Agent. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{}'

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

activedirectory_id = "activedirectory_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

begin
  #Create a new Active Directory Agent
  result = api_instance.activedirectories_agents_post(activedirectory_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_agents_post: #{e}"
end

Parameters

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

Return type

ActiveDirectoryAgentGetOutput

Authorization

x-api-key

HTTP request headers

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

activedirectories_delete

activedirectories_delete(id, content_type, accept, opts)

Delete an Active Directory

This endpoint allows you to delete an Active Directory Instance. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_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::ActiveDirectoryApi.new

id = "id_example" # String | ObjectID of this Active Directory instance.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Delete an Active Directory
  api_instance.activedirectories_delete(id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	ObjectID of this Active Directory instance.
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

activedirectories_get

ActiveDirectoryOutput activedirectories_get(id, content_type, accept, opts)

Get an Active Directory

This endpoint returns a specific Active Directory. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_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::ActiveDirectoryApi.new

id = "id_example" # String | ObjectID of this Active Directory instance.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Get an Active Directory
  result = api_instance.activedirectories_get(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	ObjectID of this Active Directory instance.
content_type	String		[default to application/json]
accept	String		[default to application/json]
x_org_id	String		[optional] [default to ]

Return type

ActiveDirectoryOutput

Authorization

x-api-key

HTTP request headers

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

activedirectories_list

Array<ActiveDirectoryOutput> activedirectories_list(content_type, accept, opts)

List Active Directories

This endpoint allows you to list all your Active Directory Instances. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/ \\ -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::ActiveDirectoryApi.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 Active Directories
  result = api_instance.activedirectories_list(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_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<ActiveDirectoryOutput>

Authorization

x-api-key

HTTP request headers

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

activedirectories_post

ActiveDirectoryOutput activedirectories_post(content_type, accept, opts)

Create a new Active Directory

This endpoint allows you to create a new Active Directory. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"domain\": \"{DC=AD_domain_name;DC=com}\" } '

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

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

begin
  #Create a new Active Directory
  result = api_instance.activedirectories_post(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->activedirectories_post: #{e}"
end

Parameters

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

Return type

ActiveDirectoryOutput

Authorization

x-api-key

HTTP request headers

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

graph_active_directory_associations_list

Array<GraphConnection> graph_active_directory_associations_list(activedirectory_id, targets, content_type, accept, opts)

List the associations of an Active Directory instance

This endpoint returns the direct associations of this Active Directory instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. #### Sample Request curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/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::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # String | 

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 an Active Directory instance
  result = api_instance.graph_active_directory_associations_list(activedirectory_id, targets, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->graph_active_directory_associations_list: #{e}"
end

Parameters

Name	Type	Description	Notes
activedirectory_id	String
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 ]

Return type

Array<GraphConnection>

Authorization

x-api-key

HTTP request headers

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

graph_active_directory_associations_post

graph_active_directory_associations_post(activedirectory_id, content_type, accept, opts)

Manage the associations of an Active Directory instance

This endpoint allows you to manage the direct associations of an Active Directory instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"user\", \"id\": \"{User_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::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

begin
  #Manage the associations of an Active Directory instance
  api_instance.graph_active_directory_associations_post(activedirectory_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->graph_active_directory_associations_post: #{e}"
end

Parameters

Name	Type	Notes
activedirectory_id	String
content_type	String	[default to application/json]
accept	String	[default to application/json]
body	GraphManagementReq	[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_active_directory_traverse_user_group

Array<GraphObjectWithPaths> graph_active_directory_traverse_user_group(activedirectory_id, content_type, accept, opts)

List the User Groups bound to an Active Directory instance

This endpoint will return all Users Groups bound to an Active Directory instance, 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 Active Directory instance 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 Active Directory instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/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::ActiveDirectoryApi.new

activedirectory_id = "activedirectory_id_example" # String | ObjectID of the Active Directory instance.

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 an Active Directory instance
  result = api_instance.graph_active_directory_traverse_user_group(activedirectory_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling ActiveDirectoryApi->graph_active_directory_traverse_user_group: #{e}"
end

Parameters

Name	Type	Description	Notes
activedirectory_id	String	ObjectID of the Active Directory instance.
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

Files

ActiveDirectoryApi.md

Latest commit

History

ActiveDirectoryApi.md

File metadata and controls

JCAPIv2::ActiveDirectoryApi

activedirectories_agents_delete

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_agents_get

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_agents_list

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_agents_post

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_delete

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_get

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_list

Example

Parameters

Return type

Authorization

HTTP request headers

activedirectories_post

Example

Parameters

Return type

Authorization

HTTP request headers

graph_active_directory_associations_list

Example

Parameters

Return type

Authorization

HTTP request headers

graph_active_directory_associations_post

Example

Parameters

Return type

Authorization

HTTP request headers

graph_active_directory_traverse_user_group

Example

Parameters

Return type

Authorization

HTTP request headers