Skip Navigation Links

Page User Assignments

Endpoint Overview

GET /api/pages/v4/pages/assignable-roles
List assignable roles
GET /api/pages/v4/pages/assignable-users
List assignable users
POST /api/pages/v4/pages/{page_id}/assignments/users
Assign user to page
GET /api/pages/v4/pages/{page_id}/assignments/users-aggregated
List aggregated page user assignments
GET /api/pages/v4/pages/{page_id}/assignments/users/{user_id}/{role_id}
Get page user assignment
DELETE /api/pages/v4/pages/{page_id}/assignments/users/{user_id}/{role_id}
Delete page user assignment

List assignable roles

Requires authentication via bearer.

List and search roles which can be assigned to a page by the actor.

Query Params

candidates_for stringrequired

Filter users that can be added to the given pageId.

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.

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

List assignable users

Requires authentication via bearer.

List and search users which can be assigned to a page by the actor.

Query Params

search_term string

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

candidates_for stringrequired

Filter users that can be added to the given pageId.

role_id string

Filter users that can be added to the given page with the given role. Otherwise users that already have any role assigned to the page will be filtered.

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.

Response Body

200 OK

Assign user to page

Requires authentication via bearer.

Assign a user to a page.

Path Params

page_id stringrequired

Unique identifier of a page.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Request Body

user_id stringrequired

Unique identifier of a user.

role_id stringrequired

Unique identifier of a role.

Response Body

200 OK

Error Codes

  • USER_ALREADY_ASSIGNED_WITH_ROLE
  • USER_NOT_FOUND
  • ROLE_NOT_FOUND

List aggregated page user assignments

Requires authentication via bearer.

Searches the user assignments of a page. The results are aggregated by user.

Path Params

page_id stringrequired

Unique identifier of a page.

Query Params

search_term string

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

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

Get page user assignment

Requires authentication via bearer.

Allows to retrieve a single user assignment of a page.

Path Params

page_id stringrequired

Unique identifier of a page.

user_id stringrequired

Unique identifier of a user.

role_id stringrequired

Unique identifier of a role.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Delete page user assignment

Requires authentication via bearer.

Removes a user assignment from a page.

Path Params

page_id stringrequired

Unique identifier of a page.

user_id stringrequired

Unique identifier of a user.

role_id stringrequired

Unique identifier of a role.

Response Body

200 OK

Error Codes

  • DERIVED_ASSIGNMENT_DELETION_FORBIDDEN