All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| GraphLdapServerAssociationsList | Get /ldapservers/{ldapserver_id}/associations | List the associations of a LDAP Server |
| GraphLdapServerAssociationsPost | Post /ldapservers/{ldapserver_id}/associations | Manage the associations of a LDAP Server |
| GraphLdapServerTraverseUser | Get /ldapservers/{ldapserver_id}/users | List the Users bound to a LDAP Server |
| GraphLdapServerTraverseUserGroup | Get /ldapservers/{ldapserver_id}/usergroups | List the User Groups bound to a LDAP Server |
| LdapserversGet | Get /ldapservers/{id} | Get LDAP Server |
| LdapserversList | Get /ldapservers | List LDAP Servers |
[]GraphConnection GraphLdapServerAssociationsList(ctx, ldapserverId, targets, contentType, accept, optional) List the associations of a LDAP Server
This endpoint returns the direct associations of this LDAP Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. #### Sample Request curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ -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. | |
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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 |
|---|---|---|---|
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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]
GraphLdapServerAssociationsPost(ctx, ldapserverId, contentType, accept, optional) Manage the associations of a LDAP Server
This endpoint allows you to manage the direct associations of a LDAP Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_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. | |
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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 |
|---|---|---|---|
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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 GraphLdapServerTraverseUser(ctx, ldapserverId, contentType, accept, optional) List the Users bound to a LDAP Server
This endpoint will return all Users bound to an LDAP Server, 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 LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -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. | |
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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 |
|---|---|---|---|
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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]
[]GraphObjectWithPaths GraphLdapServerTraverseUserGroup(ctx, ldapserverId, contentType, accept, optional) List the User Groups bound to a LDAP Server
This endpoint will return all Users Groups bound to a LDAP Server, 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 LDAP server 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 LDAP server instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_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. | |
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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 |
|---|---|---|---|
| ldapserverId | string | ObjectID of the LDAP Server. | |
| 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]
LdapServerOutput LdapserversGet(ctx, id, contentType, accept, optional) Get LDAP Server
This endpoint returns a specific LDAP server. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_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 | Unique identifier of the LDAP server. | |
| 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 | Unique identifier of the LDAP server. | |
| 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]
[]LdapServerOutput LdapserversList(ctx, contentType, accept, optional) List LDAP Servers
This endpoint returns the object IDs of your LDAP servers. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/ \ -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]