right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v5.1.0 (533 APIs)

Anfitrión de la API: https://obp-api-sandbox.nmbbank.co.tz
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Scope for a Consumer

Create Scope. Grant Role to Consumer.

Scopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is Mandatory

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

bank_id: gh.29.uk

role_name:

JSON response body fields:

bank_id: gh.29.uk

role_name:

scope_id:

Respuesta Exitosa Típica: 

								
									
{
  "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
  "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
  "bank_id":"gh.29.uk"
}
Roles Requeridos:
  • CanCreateScopeAtAnyBank - Please login to request this Role
  • CanCreateScopeAtOneBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by addScope, operation_id: OBPv4.0.0-addScope Tags: Scope, Consumer,

Delete Consumer Scope

Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID

Authentication is required and the user needs to be a Super Admin.
Super Admins are listed in the Props file.

Authentication is Mandatory

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

SCOPE_ID:

JSON response body fields:

Respuesta Exitosa Típica:
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by deleteScope, operation_id: OBPv3.0.0-deleteScope Tags: Scope, Consumer,

Get Scopes for Consumer

Get all the scopes for an consumer specified by CONSUMER_ID

Authentication is Mandatory

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

list:

role_name:

scope_id:

Respuesta Exitosa Típica: 

								
									
{
  "list":[{
    "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
    "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
    "bank_id":"gh.29.uk"
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30212: EntitlementId not found
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getScopes, operation_id: OBPv4.0.0-getScopes Tags: Scope, Consumer,