Users may inspect their own roles and server-wide base permissions. Inspecting another user requires MANAGE_ROLES or MANAGE_PERMISSIONS. Channel-specific overwrites are not included.

Request

GET http://localhost:8989/api/users/{userID}/permissions

Path parameters

Parameter name Value Description Additional
userID string

Relay user UUID.

Required

Authorisation

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

User roles and base permissions returned.

User Permissions Response
401 Unauthorized

The Authorization header is missing or malformed.

Error Response
403 Forbidden

The token is invalid or expired, or the requester lacks a required permission.

Error Response
500 Internal Server Error

The server could not complete the operation.

Error Response

Explore this API

userID

Relay user UUID.

Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Try it out!