v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

View the permissions of a user

get/v1/user_roles

Query parameters

namestring

Specify the name of the role for which you want to view the permissions.

statusstring

Specify the status of the role. Allowed values are active and deactivated.

per_pageinteger

Number of records to return per page.

page_nointeger

Current page number.

Response

200

Example response

{
  "user_roles": [
    {
      "user_role": {
        "id": 61,
        "name": "Admin",
        "permissions": [
          "alerts.manage"
        ],
        "status": "active",
        "created_at": "2022-07-06T14:45:48Z",
        "updated_at": "2022-07-06T14:45:48Z",
        "type": "default"
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 3
  }
}