Role

Collect roles (replaced by POST /v1/role/query)

Get all (or some of) the roles of which a user is a member (either directly or indirectly). The POST /v1/role/query is a preferable alternative, which can better handle complex filters.

get/v1/role

Query parameters

viewIdinteger

Only return those roles which have access to a specific view

idinteger[]

Only return roles with one of the specified ids

namestring[]

Only return roles with a name in this array

ancestorRoleIdinteger[]

Only return roles which are managed (directly or indirectly) by one of the specified ancestor role ids. Prefer the companyId query parameter

companyIdinteger[]

Only return roles which are directly or indirectly manages by one of the specified company ids

userRights.roleManagementboolean

For each of the returned roles, set the roleManagement property to indicate whether the user has direct or indirect roleManagement rights

userRights.userManagementboolean

For each of the returned roles, set the userManagement property to indicate whether the user has direct or indirect userManagement rights

userRights.viewManagementboolean

For each of the returned roles, set the viewManagement property to indicate whether the user has direct or indirect viewManagement rights

userRights.deviceManagementboolean

For each of the returned roles, set the deviceManagement property to indicate whether the user has direct or indirect deviceManagement rights

userRights.reportManagementboolean

For each of the returned roles, set the reportManagement property to indicate whether the user has direct or indirect reportManagement rights

userRights.alarmManagementboolean

For each of the returned roles, set the alarmManagement property to indicate whether the user has direct or indirect alarmManagement rights

Response

The roles of which the user is a member and which match all specified filters

Changes

No recorded changes to this endpoint across all 1 revision of this API.