About

This endpoint retrieves a list of all roles configured in the organization. Each role object includes its role name and role id.

Example

Gets a list of roles

curl -X GET "https://api.picussecurity.com/v1/users/roles?offset=0&limit=25" \
  -H "Access-Token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

{
  "roles": [
    {
      "id": 1,
      "name": "Owner"
    },
    {
      "id": 2,
      "name": "Admin"
    },
    {
      "id": 3,
      "name": "Analyst"
    },
    {
      "id": 4,
      "name": "Viewer"
    }
  ],
  "pages": {
    "offset": 0,
    "limit": 25,
    "total_pages": 1,
    "total_count": 4
  }
}