docs/BankApplicationsIdpApi

CybridApiId::BankApplicationsIdpApi

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

Method HTTP request Description
create_bank_application POST /api/bank_applications Create bank application
delete_bank_application DELETE /api/bank_applications/{client_id} Delete bank application
list_bank_applications GET /api/bank_applications List bank applications

create_bank_application

> create_bank_application(post_bank_application_idp_model)

Create bank application

Creates a bank OAuth2 application. Required scope: bank_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::BankApplicationsIdpApi.new
post_bank_application_idp_model = CybridApiId::PostBankApplicationIdpModel.new({name: 'name_example'}) # PostBankApplicationIdpModel | 

begin
  # Create bank application
  result = api_instance.create_bank_application(post_bank_application_idp_model)
  p result
rescue CybridApiId::ApiError => e
  puts "Error when calling BankApplicationsIdpApi->create_bank_application: #{e}"
end

Using the create_bank_application_with_http_info variant

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

> , Integer, Hash)> create_bank_application_with_http_info(post_bank_application_idp_model)

begin
  # Create bank application
  data, status_code, headers = api_instance.create_bank_application_with_http_info(post_bank_application_idp_model)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiId::ApiError => e
  puts "Error when calling BankApplicationsIdpApi->create_bank_application_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
post_bank_application_idp_model PostBankApplicationIdpModel

Return type

ApplicationWithSecretIdpModel

Authorization

BearerAuth, oauth2

HTTP request headers

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

delete_bank_application

> delete_bank_application(client_id)

Delete bank application

Deletes an application.Required scope: bank_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::BankApplicationsIdpApi.new
client_id = 'client_id_example' # String | Identifier for the application.

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

Using the delete_bank_application_with_http_info variant

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

> delete_bank_application_with_http_info(client_id)

begin
  # Delete bank application
  data, status_code, headers = api_instance.delete_bank_application_with_http_info(client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue CybridApiId::ApiError => e
  puts "Error when calling BankApplicationsIdpApi->delete_bank_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_bank_applications

> list_bank_applications(opts)

List bank applications

Retrieve a list of bank OAuth2 applications. Required scope: banks: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::BankApplicationsIdpApi.new
opts = {
  page: 56, # Integer | The page index to retrieve.
  per_page: 56, # Integer | The number of entities per page to return.
  bank_guid: 'bank_guid_example' # String | Bank guid to list applications for.
}

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

Using the list_bank_applications_with_http_info variant

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

> , Integer, Hash)> list_bank_applications_with_http_info(opts)

begin
  # List bank applications
  data, status_code, headers = api_instance.list_bank_applications_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiId::ApiError => e
  puts "Error when calling BankApplicationsIdpApi->list_bank_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]
bank_guid String Bank guid to list applications for. [optional]

Return type

ApplicationListIdpModel

Authorization

BearerAuth, oauth2

HTTP request headers

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