Get roles

Request syntax

Path parameters

name (string)

The unique name of the role in the library.

Example

> GET /v1/authentication/roles
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992

[
    {
         "name": "Administrator",
         "type": "default",
         "users": 4,
         "sessions": 2
    }, {
         "name": "Monitor",
         "type": "default",
         "users": 1,  
         "sessions": 0
    }, {
         "name": "Local Service",
         "type": "default",
         "users": 1,
         "sessions": 0
    }, {
         "name": "Superuser",
         "type": "default",
         "users": 0,
         "sessions": 0  
    }, {
         "name": "adminGroup_mycompany",
         "type": "custom",
         "users": 1,
         "sessions": 0
    }, {
         "name": "automation_mycompany",
         "type": "custom",
         "users": 1,
         "sessions": 1
    }
]

Example

name (string)

The unique name of the user role.

type (string)

Identifies if this is a default user role that comes installed on the library or a custom user roll that is created by the user either to map to a remote authentication user group or a role with custom permissions that are defined by the user.

users (number)

The number of local user accounts mapped to this role.

sessions (number)

The number of local and remote user accounts that are logged in to the library by using this user role.