OrganizationsApi.md

JCAPIv2::OrganizationsApi

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

Method	HTTP request	Description
org_crypto_get	GET /organizations/{id}/crypto	Get Crypto Settings
org_crypto_put	PUT /organizations/{id}/crypto	Edit Crypto Settings

org_crypto_get

OrgCryptoSettings org_crypto_get(id, content_type, accept, opts)

Get Crypto Settings

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.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 = JCAPIv2::OrganizationsApi.new

id = "id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  fields: ["fields_example"], # Array<String> | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
}

begin
  #Get Crypto Settings
  result = api_instance.org_crypto_get(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling OrganizationsApi->org_crypto_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
content_type	String		[default to application/json]
accept	String		[default to application/json]
fields	Array<String>	The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.	[optional]
filter	Array<String>	Supported operators are: eq, ne, gt, ge, lt, le, between, search, in	[optional]
x_org_id	String		[optional] [default to ]
skip	Integer	The offset into the records to return.	[optional] [default to 0]
sort	Array<String>	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.	[optional]
limit	Integer	The number of records to return at once. Limited to 100.	[optional] [default to 10]

Return type

OrgCryptoSettings

Authorization

x-api-key

HTTP request headers

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

org_crypto_put

Object org_crypto_put(id, content_type, accept, opts)

Edit Crypto Settings

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.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 = JCAPIv2::OrganizationsApi.new

id = "id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::OrgCryptoSettings.new, # OrgCryptoSettings | 
  fields: ["fields_example"], # Array<String> | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
}

begin
  #Edit Crypto Settings
  result = api_instance.org_crypto_put(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling OrganizationsApi->org_crypto_put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
content_type	String		[default to application/json]
accept	String		[default to application/json]
body	OrgCryptoSettings		[optional]
fields	Array<String>	The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.	[optional]
filter	Array<String>	Supported operators are: eq, ne, gt, ge, lt, le, between, search, in	[optional]
x_org_id	String		[optional] [default to ]
skip	Integer	The offset into the records to return.	[optional] [default to 0]
sort	Array<String>	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.	[optional]
limit	Integer	The number of records to return at once. Limited to 100.	[optional] [default to 10]

Return type

Object

Authorization

x-api-key

HTTP request headers

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