API Explorer

v4.0.0 (353 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create a Authentication Type Validation

Create a Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanCreateAuthenticationTypeValidation - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by createAuthenticationTypeValidation, operation_id: OBPv4.0.0-createAuthenticationTypeValidation

Delete a Authentication Type Validation

Delete a Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteAuthenticationValidation - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by deleteAuthenticationTypeValidation, operation_id: OBPv4.0.0-deleteAuthenticationTypeValidation

Get a Authentication Type Validation

Get a Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getAuthenticationTypeValidation, operation_id: OBPv4.0.0-getAuthenticationTypeValidation

Get all Authentication Type Validations

Get all Authentication Type Validations.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "authentication_types_validations":[{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }] }
Required Roles:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getAllAuthenticationTypeValidation, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidation

Update a Authentication Type Validation

Update a Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanUpdateAuthenticationTypeValidation - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by updateAuthenticationTypeValidation, operation_id: OBPv4.0.0-updateAuthenticationTypeValidation