right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (546 APIs)

API Host: https://obp-api-sandbox.nmbbank.co.tz
Bank
Accounts
Views
Counterparties
Transactions

Create an Authentication Type Validation

Create an Authentication Type Validation.

Please supply allowed authentication types.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

JSON response body fields:

Typical Successful Response: 

								
									
{
  "operation_id":"OBPv4.0.0-updateXxx",
  "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
}
Required Roles:
  • CanCreateAuthenticationTypeValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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:
Version: OBPv4.0.0, function_name: by createAuthenticationTypeValidation, operation_id: OBPv4.0.0-createAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Delete an Authentication Type Validation

Delete an Authentication Type Validation by operation_id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response: 

								
									
true
Required Roles:
  • CanDeleteAuthenticationValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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:
Version: OBPv4.0.0, function_name: by deleteAuthenticationTypeValidation, operation_id: OBPv4.0.0-deleteAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Get all Authentication Type Validations

Get all Authentication Type Validations.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response: 

								
									
{
  "authentication_types_validations":[{
    "operation_id":"OBPv4.0.0-updateXxx",
    "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
  }]
}
Required Roles:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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:
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidations, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidations Tags: Authentication-Type-Validation,

Get all Authentication Type Validations - public

Get all Authentication Type Validations - public.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

Typical Successful Response: 

								
									
{
  "authentication_types_validations":[{
    "operation_id":"OBPv4.0.0-updateXxx",
    "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidationsPublic, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidationsPublic Tags: Authentication-Type-Validation,

Get an Authentication Type Validation

Get an Authentication Type Validation by operation_id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response: 

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

Update an Authentication Type Validation

Update an Authentication Type Validation.

Please supply allowed authentication types.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response: 

								
									
{
  "operation_id":"OBPv4.0.0-updateXxx",
  "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
}
Required Roles:
  • CanUpdateAuthenticationTypeValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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:
Version: OBPv4.0.0, function_name: by updateAuthenticationTypeValidation, operation_id: OBPv4.0.0-updateAuthenticationTypeValidation Tags: Authentication-Type-Validation,