Role

A userrole object

accessRightsstring[]required

defines whether the user can access the UI, the API, or both.

Possible values: [APIS, MAMBU]

creationDatestring<date-time>required

the date and time when this role was created

encodedKeystringrequired

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstringrequired

the ID for this role

isAdministratorbooleanrequired

whether this role is for an administrator. Please note if this option is selected, the user will have blanket access, it is not possible to restict access for administrators using the permissions object.

isCreditOfficerbooleanrequired

whether this role represents a credit/loan officer type of user

isDeliveryboolean

whether this role relates to Mambu delivery users. Delivery teams need have accounts to assist you during the intitial setup stage, which will be disabled when you start using Mambu in production

isSupportbooleanrequired

whether this is a role for Mambu support users. Mambu users may, on request, be granted access to your system in order to troubleshoot problems

isTellerbooleanrequired

whether this role is for a 'teller' type user who will manage tills

lastModifiedDatestring<date-time>required

the date on which this role was last modified

namestringrequired

the name of this role

permissions objectrequired

Description for permissions in role

canManageAllBranchesbooleanrequired

indicates whether the user can manage all branches or only they one they are assigned to

canManageEntitiesAssignedToOtherOfficersbooleanrequired

indicates whether the user can edit clients and accounts which are assigned to other Mambu users

encodedKeystringrequired

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

permissionsstring[]required

a list of permissions

Role

{
  "accessRights": [
    "APIS"
  ],
  "creationDate": "2024-07-29T15:51:28.071Z",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isDelivery": true,
  "isSupport": true,
  "isTeller": true,
  "lastModifiedDate": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "string"
    ]
  }
}