OIDCApi.md

BudgeaClient::OIDCApi

All URIs are relative to https://demo.biapi.pro/2.0/

Method	HTTP request	Description
oidc_whitelist_id_whitelist_delete	DELETE /oidc/whitelist/{id_whitelist}	Delete the supplied authorized redirect uri
oidc_whitelist_id_whitelist_post	POST /oidc/whitelist/{id_whitelist}	Edit a authorized redirect uri
oidc_whitelist_post	POST /oidc/whitelist	Adds an authorized redirect uri

oidc_whitelist_id_whitelist_delete

OidcWhitelist oidc_whitelist_id_whitelist_delete(id_whitelist, opts)

Delete the supplied authorized redirect uri

Example

# load the gem
require 'budgea_client'
# setup authorization
BudgeaClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = BudgeaClient::OIDCApi.new

id_whitelist = 56 # Integer | 

opts = { 
  expand: 'expand_example' # String | 
}

begin
  #Delete the supplied authorized redirect uri
  result = api_instance.oidc_whitelist_id_whitelist_delete(id_whitelist, opts)
  p result
rescue BudgeaClient::ApiError => e
  puts "Exception when calling OIDCApi->oidc_whitelist_id_whitelist_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id_whitelist	Integer
expand	String		[optional]

Return type

OidcWhitelist

Authorization

api_key

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

oidc_whitelist_id_whitelist_post

OidcWhitelist oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts)

Edit a authorized redirect uri

Edit the uri for the supplied authorized redirect uri.

Example

# load the gem
require 'budgea_client'
# setup authorization
BudgeaClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = BudgeaClient::OIDCApi.new

id_whitelist = 56 # Integer | 

redirect_uri = 'redirect_uri_example' # String | new authorized redirect uri

opts = { 
  expand: 'expand_example' # String | 
}

begin
  #Edit a authorized redirect uri
  result = api_instance.oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts)
  p result
rescue BudgeaClient::ApiError => e
  puts "Exception when calling OIDCApi->oidc_whitelist_id_whitelist_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id_whitelist	Integer
redirect_uri	String	new authorized redirect uri
expand	String		[optional]

Return type

OidcWhitelist

Authorization

api_key

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

oidc_whitelist_post

OidcWhitelist oidc_whitelist_post(redirect_uri, opts)

Adds an authorized redirect uri

It requires the authorized redirect uri to be created

Example

# load the gem
require 'budgea_client'
# setup authorization
BudgeaClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = BudgeaClient::OIDCApi.new

redirect_uri = 'redirect_uri_example' # String | authorized redirect uri to be created

opts = { 
  expand: 'expand_example' # String | 
}

begin
  #Adds an authorized redirect uri
  result = api_instance.oidc_whitelist_post(redirect_uri, opts)
  p result
rescue BudgeaClient::ApiError => e
  puts "Exception when calling OIDCApi->oidc_whitelist_post: #{e}"
end

Parameters

Name	Type	Description	Notes
redirect_uri	String	authorized redirect uri to be created
expand	String		[optional]

Return type

OidcWhitelist

Authorization

api_key

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json