Skip Navigation Links

Channel Assignments Users

Endpoint Overview

GET /api/admin/channels/v4/channels/{channel_id}/assignable-roles
List Assignable Roles
GET /api/admin/channels/v4/channels/{channel_id}/assignments/users
List Channel User Role Assignments
POST /api/admin/channels/v4/channels/{channel_id}/assignments/users/{user_id}/roles
Create channel user role assignment
GET /api/admin/channels/v4/channels/{channel_id}/assignments/users/{user_id}/roles/{role_id}
Get Channel User Role Assignment
DELETE /api/admin/channels/v4/channels/{channel_id}/assignments/users/{user_id}/roles/{role_id}
Delete channel user role assignment

List Assignable Roles

Requires authentication via bearer.

Returns all roles that can be assigned to the channel by the current actor.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Query Params

sort string[]
page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

List Channel User Role Assignments

Requires authentication via bearer.

Gets all roles of all users that are assigned to the channel. Includes user role assignments that are derived from user group assignments.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Query Params

search_term string

A term that needs a match in the user's first name, last name or department.

role_id string

Filters the resulting assignments by the specified role.

source string

Filters the resulting assignments by the specified assignment source.

sort string[]
page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Create channel user role assignment

Requires authentication via bearer.

Assigns a channel role to the specified user and channel.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

user_id stringrequired

The primary identifier of the user.

Request Body

role_id stringrequired

Unique identifier of a role.

Response Body

201 Created

Error Codes

  • USER_NOT_ASSIGNABLE
  • ROLE_NOT_FOUND
  • ROLE_NOT_ASSIGNABLE

Get Channel User Role Assignment

Requires authentication via bearer.

Gets a specific channel user role assignment.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

user_id stringrequired

The primary identifier of the user.

role_id stringrequired

The primary identifier of the role.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Delete channel user role assignment

Requires authentication via bearer.

Deletes a channel role from the specified user and channel.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

user_id stringrequired

The primary identifier of the user.

role_id stringrequired

The primary identifier of the role.

Response Body

200 OK

Error Codes

  • CHANNEL_USER_ASSIGNMENT_NOT_FOUND
  • ROLE_ASSIGNMENT_NOT_DELETABLE