Get a collection of roles.

get

https://senaps.eratos.com/api/sensor/v2/roles

This operation returns a list of all roles or all roles in the authorised organisation. An admin role with read role permission is required, or an organisational role with role read permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Only return roles with this id or partial match using wildcards (*, ?).

matches zero or more characters.
? matches exactly one character.

For example, bo* will match any word starting with bo, such as bo, bom, body, and so on. On the other hand, bo? will only match three-letter words starting with bo, such as bo, bom, and so on.

type

string

Filter roles by their type.
If provided, must be one of '.AdministrationRole', '.OrganisationRole' or '.GroupRole'.

permissions

string

Filter roles by the permission(s) they grant.
Multiple permissions may be specified as a comma-separated list.

organisationids

string

Filter roles by their associated organisations.
Not valid if 'type' specifies the .AdministrationRole type.
Multiple organisation IDs may be specified as a comma-separated list.

groupids

string

Filter roles by their associated groups.
Only valid if 'type' specifies the .GroupRole type.
Multiple group IDs may be specified as a comma-separated list.

limit

number

Maximum number of roles to return

skip

number

Skip this many results.

expand

boolean

Return full details of roles

recursive

boolean

Return full details of related objects

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response containing role details.

401The client has insufficient authorisation.