User role resources

Get user roles

This API endpoint has been deprecated by version 2.122.0 in favour of the new Accounts GraphQL API.

GET /users/:ID/roles

Returns all roles that are assigned to the specified user. It's not guaranteed that the user is eligible for all assigned roles in the network context. For example, evaluation of roles may be influenced by OnBehalf Access.

API authorization

Clients are recommended to work with the evaluated user roles endpoint, if effective role-assignments need to be known before doing an API request. Authorization on API requests are always checked against evaluated roles.

Get my user roles

This API endpoint has been deprecated by version 2.122.0 in favour of the new Accounts GraphQL API

Returns all roles that are assigned to the user of the current session.

GET /users/me/roles

Response

["user"]

Get evaluated roles

Returns all roles the user is eligible for in the network context.

GET /users/:ID/roles/evaluated

Get my evaluated roles

Returns all roles the user of the current session is eligible for in the network context.

GET /users/me/roles/evaluated

Response

["user-limited"]

Set roles

This API endpoint has been deprecated by version 2.122.0 in favour of the new Accounts GraphQL API.

Set a list of roles for a user. To see a list of all available roles see Concepts|Roles

PUT /users/:ID/roles

INFO:Setting the roles replaces all existing roles!

Json Payload

["user"]

Response

["user"]

Get all roles

GET /roles

Retrieve a list of all available roles.

Response

[
  "api_user",
  "communication_admin",
  "content_admin",
  "network_statistics_admin",
  "read_only",
  "settings_admin",
  "user",
  "user_admin",
  "user_statistics_admin"
]