Create new customer role.

To save customer role details in the system.

SecurityoAuth2
Request
path Parameters
customerId
required
string

Customer unique identifier and which is associated with the token legal entity

Request Body schema: application/json
required

Customer role fileds

externalReferenceId
required
string

Unique reference id from a system outside of finzly. The external reference id can be used by the finzly for the request tracing (if needed).

name
required
string

A valid role name can consist of alphanumeric characters.

description
required
string

Description for the role.

required
Array of objects (RoleApplication)

Customer applications which are present in the Bank's customer app store. Minimum one application should be provided.

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Save user details

post/api/user-management/v1/customers/{customerId}/roles
Request samples
application/json
{
  • "externalReferenceId": "Role101",
  • "name": "Admin, ManagerRole1",
  • "description": "Role for admin users",
  • "applications": [
    ]
}
Response samples
application/json
{
  • "roleId": "123fdhsfh47834jsdh84754",
  • "message": "<Reason>",
  • "data": { }
}