Staff Permission Override List

Entity description

An entity holding the list of permissions that override the default permissions of the BusinessRole assigned to the staff member. When empty, role defaults are assigned to the user.

Properties

Name	Description	Type	Example
staff_uid	The unique identifier (UID) of the staff member	string	`d290f1ee-6c54-4b01-90e6-d701748f0851`
permissions	A list of permissions that override the default permissions of the BusinessRole assigned to the staff member. Each permission includes a unique identifier (UID) and a state that can be `allow`, `deny`, or `inherit`	array	`[{ "key": "payments.invoices.export", "state": "allow" }, { "key": "payments.invoices.import", "state": "allow" }, { "key": "payments.invoices.view", "state": "deny" }, { "key": "payments.invoices.delete", "state": "deny" }, { "key": "payments.invoices.create", "state": "allow" }]`
created_at	Date the permission overrides were created	string	`2021-07-20T14:00:00.000Z`
updated_at	Date the permission overrides were last updated	string	`2021-07-20T14:00:00.000Z`

Example

{
  "staff_uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "permissions": [
    {
      "key": "payments.invoices.export",
      "state": "allow"
    },
    {
      "key": "payments.invoices.import",
      "state": "allow"
    },
    {
      "key": "payments.invoices.view",
      "state": "deny"
    },
    {
      "key": "payments.invoices.delete",
      "state": "deny"
    },
    {
      "key": "payments.invoices.create",
      "state": "allow"
    }
  ],
  "created_at": "2021-07-20T14:00:00.000Z",
  "updated_at": "2021-07-20T14:00:00.000Z"
}