RolePermissionsPreviewDto

Example

JSON

{
  "blockers": [
    {
      "code": "hierarchy.reparent_cycle",
      "message": "string"
    }
  ],
  "people_named": false,
  "identities_gaining": 0,
  "identities_losing": 0,
  "permissions": [
    {
      "permission": "string",
      "gaining": 0,
      "losing": 0
    }
  ],
  "people": {
    "items": [
      {
        "identity": {
          "id": "string",
          "first_name": "string",
          "last_name": "string",
          "name": "string",
          "email": "string",
          "avatar_url": "string"
        },
        "gained": [
          "string"
        ],
        "lost": [
          "string"
        ],
        "via": [
          {
            "role": {
              "id": null,
              "name": null
            },
            "node": {
              "id": null,
              "name": null
            }
          }
        ]
      }
    ],
    "pagination": {
      "page": 0,
      "take": 0,
      "item_count": 0,
      "page_count": 0,
      "has_previous_page": false,
      "has_next_page": false
    }
  },
  "role_id": "string",
  "version": 0,
  "role_active": false,
  "added": [
    "string"
  ],
  "removed": [
    "string"
  ],
  "holders": 0
}

Properties

12 properties 12 required

blockers array of PreviewBlockerDto Required

What would refuse the change. When any is listed, nothing below is resolved

people_named boolean Required

Whether people are named: false for a reader who may not see the Environment's people, who gets the counts and no list

identities_gaining number Required

Holders who gain at least one permission

identities_losing number Required

Holders who lose at least one permission

permissions array of PermissionChangeCountDto Required

people object Required

One page of the people the change reaches. The counts above cover everyone; the page follows the query

role_id string Required

version number Required

The role's version now: send it as `If-Match` on the permissions write

role_active boolean Required

A disabled role grants nothing, so no holder's access moves

added array of string Required

removed array of string Required

holders number Required

Identities the role grants something to now

Was this page helpful?

Tell us how we can improve this guide.