Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.46 KB

OrganizationsApi.md

File metadata and controls

53 lines (36 loc) · 2.46 KB

\OrganizationsApi

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

Method HTTP request Description
OrganizationList Get /organizations Get Organization Details

OrganizationList

Organizationslist OrganizationList(ctx, contentType, accept, optional) Get Organization Details

This endpoint returns Organization Details. #### Sample Request curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -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 Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. [default to ]
filter string A filter to apply to the query.
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 Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. [default to ]
search string A nested object containing a string `searchTerm` and a list of `fields` to search on.

Return type

Organizationslist

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]