Skip to content

Files

Latest commit

7231fe7 · Sep 26, 2018

History

History
52 lines (35 loc) · 2.27 KB

DirectoriesApi.md

File metadata and controls

52 lines (35 loc) · 2.27 KB

\DirectoriesApi

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

Method HTTP request Description
DirectoriesList Get /directories List All Directories

DirectoriesList

[]Directory DirectoriesList(ctx, contentType, accept, optional) List All Directories

This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/directories \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

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

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.
limit int32 The number of records to return at once. Limited to 100. [default to 10]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]Directory

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]