Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
333 lines (239 loc) · 8.92 KB

ApplicationsApi.md

File metadata and controls

333 lines (239 loc) · 8.92 KB

JCAPIv1::ApplicationsApi

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

Method HTTP request Description
applications_delete DELETE /applications/{id} Delete an Application
applications_get GET /applications/{id} Get an Application
applications_list GET /applications Applications
applications_post POST /applications Create an Application
applications_put PUT /applications/{id} Update an Application

applications_delete

Application applications_delete(id, opts)

Delete an Application

The endpoint deletes an SSO / SAML Application.

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::ApplicationsApi.new

id = "id_example" # String | 

opts = { 
  content_type: "content_type_example", # String | 
  accept: "accept_example", # String | 
  x_org_id: "x_org_id_example" # String | 
}

begin
  #Delete an Application
  result = api_instance.applications_delete(id, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationsApi->applications_delete: #{e}"
end

Parameters

Name Type Description Notes
id String
content_type String [optional]
accept String [optional]
x_org_id String [optional]

Return type

Application

Authorization

x-api-key

HTTP request headers

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

applications_get

Application applications_get(id, opts)

Get an Application

The endpoint retrieves an SSO / SAML Application.

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::ApplicationsApi.new

id = "id_example" # String | 

opts = { 
  content_type: "content_type_example", # String | 
  accept: "accept_example", # String | 
  x_org_id: "x_org_id_example" # String | 
}

begin
  #Get an Application
  result = api_instance.applications_get(id, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationsApi->applications_get: #{e}"
end

Parameters

Name Type Description Notes
id String
content_type String [optional]
accept String [optional]
x_org_id String [optional]

Return type

Application

Authorization

x-api-key

HTTP request headers

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

applications_list

Applicationslist applications_list(content_type, accept, opts)

Applications

The endpoint returns all your SSO / SAML Applications. #### Sample Request curl -X GET https://console.jumpcloud.com/api/applications \\ -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::ApplicationsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  fields: "fields_example", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
  limit: 56, # Integer | The number of records to return at once.
  skip: 56, # Integer | The offset into the records to return.
  sort: "The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.", # String | 
  filter: "filter_example" # String | A filter to apply to the query.
  x_org_id: "" # String | 
}

begin
  #Applications
  result = api_instance.applications_list(content_type, accept, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationsApi->applications_list: #{e}"
end

Parameters

Name Type Description Notes
content_type 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. [optional]
limit Integer The number of records to return at once. [optional]
skip Integer The offset into the records to return. [optional]
sort String [optional] [default to The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.]
filter String A filter to apply to the query. [optional]
x_org_id String [optional] [default to ]

Return type

Applicationslist

Authorization

x-api-key

HTTP request headers

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

applications_post

Application applications_post(opts)

Create an Application

The endpoint adds a new SSO / SAML Applications.

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::ApplicationsApi.new

opts = { 
  body: JCAPIv1::Application.new, # Application | 
  content_type: "content_type_example", # String | 
  accept: "accept_example", # String | 
  x_org_id: "x_org_id_example" # String | 
}

begin
  #Create an Application
  result = api_instance.applications_post(opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationsApi->applications_post: #{e}"
end

Parameters

Name Type Description Notes
body Application [optional]
content_type String [optional]
accept String [optional]
x_org_id String [optional]

Return type

Application

Authorization

x-api-key

HTTP request headers

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

applications_put

Application applications_put(id, opts)

Update an Application

The endpoint updates a SSO / SAML Application.

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::ApplicationsApi.new

id = "id_example" # String | 

opts = { 
  body: JCAPIv1::Application.new, # Application | 
  content_type: "content_type_example", # String | 
  accept: "accept_example", # String | 
  x_org_id: "x_org_id_example" # String | 
}

begin
  #Update an Application
  result = api_instance.applications_put(id, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationsApi->applications_put: #{e}"
end

Parameters

Name Type Description Notes
id String
body Application [optional]
content_type String [optional]
accept String [optional]
x_org_id String [optional]

Return type

Application

Authorization

x-api-key

HTTP request headers

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