Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 3.8 KB

OrganizationsApi.md

File metadata and controls

77 lines (57 loc) · 3.8 KB

jcapiv1.OrganizationsApi

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

Method HTTP request Description
organization_list GET /organizations Get Organization Details

organization_list

Organizationslist organization_list(content_type, accept, fields=fields, filter=filter, limit=limit, skip=skip, sort=sort, search=search)

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}'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.OrganizationsApi(jcapiv1.ApiClient(configuration))
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
limit = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.  (optional) (default to )
search = 'search_example' # str | A nested object containing a string `searchTerm` and a list of `fields` to search on. (optional)

try:
    # Get Organization Details
    api_response = api_instance.organization_list(content_type, accept, fields=fields, filter=filter, limit=limit, skip=skip, sort=sort, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->organization_list: %s\n" % e)

Parameters

Name Type Description Notes
content_type str [default to application/json]
accept str [default to application/json]
fields str 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. [optional] [default to ]
filter str A filter to apply to the query. [optional]
limit int The number of records to return at once. Limited to 100. [optional] [default to 10]
skip int The offset into the records to return. [optional] [default to 0]
sort str Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. [optional] [default to ]
search str A nested object containing a string `searchTerm` and a list of `fields` to search on. [optional]

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]