Authentication

Using the API key, customers can create a token to call different APIs. API key is associated with scopes (permissions).

For example:

policyprofile:get – Get policy details

policyprofile:add – Create new policy

policyprofile:update – Update different attributes on a policy (for example, enable or disable downloads).

API calls are restricted to the scope of the API key. API Calls outside of the specified scope will result in an error code status 401.
Note:
  • Customers are responsible for keeping API keys secure.
  • The RBI Operations team can disable a compromised or lost API key.

API Integration Flow

Get Token from API Key

Receive the auth_token (bearer token) as response token API.

Request
Method URL
POST {AdminPortal_URL}/api/tokens
Type Params Name Param Datatype/Value Description
REQ_PARAM api_key string Key required to generate short lived token.
REQ_PARAM identityProvider string Identity provider type. For example, “APIKEY”
REQ_PARAM tenantId string Tenant id required for which token will be generated.

Example:

Response
Status Response
200
Request Body
{
    "apikey":{api_key},
    "identityProvider": "APIKey",
    "tenantId": {tenant id} 
}
Response Body
{
        "token": AuthToken(example below)
}

token(string) - all further API calls must have this token as bearer token.

401
{
    "errorKey": "Key_InvalidAPIKey",
    "identityProviderID": "00000000-0000-0000-0000-000000000000",
    "identityProviderType": ""
}

Example: AuthToken

“fp_oidc_at_iSqyUCbnjMxm-u7w53Cavd5hTcIu3FqE3qkmI8Fuplc.jYYYtAl8ZboVtEn9NtBD-HoEzsuRdo5f_p_wDGAuyOw”