CybridApiId::OrganizationApplicationsIdpApi

All URIs are relative to https://id.sandbox.cybrid.app

Method	HTTP request	Description
create_organization_application	POST /api/organization_applications	Create organization application
delete_organization_application	DELETE /api/organization_applications/{client_id}	Delete organization application
list_organization_applications	GET /api/organization_applications	List organization applications

create_organization_application

> create_organization_application(post_organization_application_idp_model)

Create organization application

Create an organization OAuth2 application. Required scope: organization_applications:execute

Examples

require 'time'
require 'cybrid_api_id_ruby'
# setup authorization
CybridApiId.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiId::OrganizationApplicationsIdpApi.new
post_organization_application_idp_model = CybridApiId::PostOrganizationApplicationIdpModel.new({name: 'name_example'}) # PostOrganizationApplicationIdpModel | 

begin
  # Create organization application
  result = api_instance.create_organization_application(post_organization_application_idp_model)
  p result
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->create_organization_application: #{e}"
end

Using the create_organization_application_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> , Integer, Hash)> create_organization_application_with_http_info(post_organization_application_idp_model)

begin
  # Create organization application
  data, status_code, headers = api_instance.create_organization_application_with_http_info(post_organization_application_idp_model)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->create_organization_application_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
post_organization_application_idp_model	PostOrganizationApplicationIdpModel

Return type

ApplicationWithSecretIdpModel

Authorization

BearerAuth, oauth2

HTTP request headers

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

delete_organization_application

> delete_organization_application(client_id)

Delete organization application

Deletes an application.Required scope: organization_applications:execute

Examples

require 'time'
require 'cybrid_api_id_ruby'
# setup authorization
CybridApiId.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiId::OrganizationApplicationsIdpApi.new
client_id = 'client_id_example' # String | Identifier for the application.

begin
  # Delete organization application
  api_instance.delete_organization_application(client_id)
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->delete_organization_application: #{e}"
end

Using the delete_organization_application_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

> delete_organization_application_with_http_info(client_id)

begin
  # Delete organization application
  data, status_code, headers = api_instance.delete_organization_application_with_http_info(client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->delete_organization_application_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
client_id	String	Identifier for the application.

Return type

nil (empty response body)

Authorization

BearerAuth, oauth2

HTTP request headers

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

list_organization_applications

> list_organization_applications(opts)

List organization applications

Retrieve a list of organization OAuth2 applications. Required scope: organizations:read

Examples

require 'time'
require 'cybrid_api_id_ruby'
# setup authorization
CybridApiId.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiId::OrganizationApplicationsIdpApi.new
opts = {
  page: 56, # Integer | The page index to retrieve.
  per_page: 56 # Integer | The number of entities per page to return.
}

begin
  # List organization applications
  result = api_instance.list_organization_applications(opts)
  p result
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->list_organization_applications: #{e}"
end

Using the list_organization_applications_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> , Integer, Hash)> list_organization_applications_with_http_info(opts)

begin
  # List organization applications
  data, status_code, headers = api_instance.list_organization_applications_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiId::ApiError => e
  puts "Error when calling OrganizationApplicationsIdpApi->list_organization_applications_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
page	Integer	The page index to retrieve.	[optional]
per_page	Integer	The number of entities per page to return.	[optional]

Return type

ApplicationListIdpModel

Authorization

BearerAuth, oauth2

HTTP request headers

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