OrganizationsApi.md

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, opts)

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

# load the gem
require 'jcapiv1'
# setup authorization
JCAPIv1.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv1::OrganizationsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  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. 
  filter: "filter_example" # String | A filter to apply to the query.
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: "", # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. 
  search: "search_example", # String | A nested object containing a string `searchTerm` and a list of `fields` to search on.
}

begin
  #Get Organization Details
  result = api_instance.organization_list(content_type, accept, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling OrganizationsApi->organization_list: #{e}"
end

Parameters

Name	Type	Description	Notes
content_type	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.	[optional] [default to ]
filter	String	A filter to apply to the query.	[optional]
limit	Integer	The number of records to return at once. Limited to 100.	[optional] [default to 10]
skip	Integer	The offset into the records to return.	[optional] [default to 0]
sort	String	Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.	[optional] [default to ]
search	String	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