All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| ActivedirectoriesAgentsDelete | Delete /activedirectories/{activedirectory_id}/agents/{agent_id} | Delete Active Directory Agent |
| ActivedirectoriesAgentsGet | Get /activedirectories/{activedirectory_id}/agents/{agent_id} | Get Active Directory Agent |
| ActivedirectoriesAgentsList | Get /activedirectories/{activedirectory_id}/agents | List Active Directory Agents |
| ActivedirectoriesAgentsPost | Post /activedirectories/{activedirectory_id}/agents | Create a new Active Directory Agent |
| ActivedirectoriesDelete | Delete /activedirectories/{id} | Delete an Active Directory |
| ActivedirectoriesGet | Get /activedirectories/{id} | Get an Active Directory |
| ActivedirectoriesList | Get /activedirectories | List Active Directories |
| ActivedirectoriesPost | Post /activedirectories | Create a new Active Directory |
| GraphActiveDirectoryAssociationsList | Get /activedirectories/{activedirectory_id}/associations | List the associations of an Active Directory instance |
| GraphActiveDirectoryAssociationsPost | Post /activedirectories/{activedirectory_id}/associations | Manage the associations of an Active Directory instance |
| GraphActiveDirectoryTraverseUserGroup | Get /activedirectories/{activedirectory_id}/usergroups | List the User Groups bound to an Active Directory instance |
ActivedirectoriesAgentsDelete(ctx, activedirectoryId, agentId, contentType, accept, optional) Delete Active Directory Agent
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| agentId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| agentId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| xOrgId | string | [default to ] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ActiveDirectoryAgentListOutput ActivedirectoriesAgentsGet(ctx, activedirectoryId, agentId, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| agentId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| agentId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| xOrgId | string | [default to ] |
ActiveDirectoryAgentListOutput
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]ActiveDirectoryAgentListOutput ActivedirectoriesAgentsList(ctx, activedirectoryId, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| 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] |
| sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | |
| xOrgId | string | [default to ] |
[]ActiveDirectoryAgentListOutput
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ActiveDirectoryAgentGetOutput ActivedirectoriesAgentsPost(ctx, activedirectoryId, contentType, accept, optional) 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 '{}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| body | ActiveDirectoryAgentInput | ||
| xOrgId | string | [default to ] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ActivedirectoriesDelete(ctx, id, contentType, accept, optional) 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'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ObjectID of this Active Directory instance. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ObjectID of this Active Directory instance. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| xOrgId | string | [default to ] |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ActiveDirectoryOutput ActivedirectoriesGet(ctx, id, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ObjectID of this Active Directory instance. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ObjectID of this Active Directory instance. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| xOrgId | string | [default to ] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]ActiveDirectoryOutput ActivedirectoriesList(ctx, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| fields | []string | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. | |
| 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 ] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ActiveDirectoryOutput ActivedirectoriesPost(ctx, contentType, accept, optional) 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}\" } '
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| body | ActiveDirectoryInput | ||
| xOrgId | string | [default to ] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphConnection GraphActiveDirectoryAssociationsList(ctx, activedirectoryId, targets, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| targets | []string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| targets | []string | ||
| 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 ] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GraphActiveDirectoryAssociationsPost(ctx, activedirectoryId, contentType, accept, optional) 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}\" } '
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ||
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| body | GraphManagementReq | ||
| xOrgId | string | [default to ] |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GraphObjectWithPaths GraphActiveDirectoryTraverseUserGroup(ctx, activedirectoryId, contentType, accept, optional) 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}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| activedirectoryId | string | ObjectID of the Active Directory instance. | |
| contentType | string | [default to application/json] | |
| accept | string | [default to application/json] | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| activedirectoryId | string | ObjectID of the Active Directory instance. | |
| 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] |
| xOrgId | string | [default to ] | |
| skip | int32 | The offset into the records to return. | [default to 0] |
| filter | []string | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]