Get Roles

Retrieves a list of all roles defined for this tenant.

GET /platform/adminuser/roles

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "behaviors": [
        {
          "categoryId": 123,
          "id": 123,
          "isPrivate": true,
          "name": "<string>",
          "requiresBehaviorIds": [
            123
          ],
          "systemRoles": [
            "<string>"
          ],
          "validUserTypes": [
            "<string>"
          ]
        }
      ],
      "id": 123,
      "isSystemRole": true,
      "name": "<string>",
      "owners": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "resources": [
        {
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "userScope": {
        "id": 123,
        "name": "<string>",
        "type": "<string>"
      }
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 25

filter · string

Optional filter param to filter the roles

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

totalCount · integer<int32>