User_display_permissions

>>>

GET /api/v4/users/user_display_permissions
Get Workspace Users for display. Last update: 11/07/25

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 1,
    "name": "11 1",
    "touch_role": "admin",
    "display_role": "no_role",
    "allowed_display": false
  },
  ...
]

Params

Param name Description
display_id
required

ID of display

Validations:

  • Must be a Integer
>>>

PUT api/v4/users/user_display_permissions
Update user display permissions

Request headers ↑

Only registered user can perform this action

Authentication - string - required
  Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "message": "User display permissions updated",
  "list_for_add": [
      "Donald Duck"
  ],
  "list_for_remove": [
      "Mickey Mouse"
  ]
}

Params

Param name Description
user_ids
required

Validations:

  • Must be an array of Integer
touch_role
optional

Validations:

  • Must be a String
display_role
optional

Validations:

  • Must be a String
display_id
optional

Validations:

  • Must be a Integer
display_name
optional

Validations:

  • Must be a String
allowed_touch_ids
optional

Array of touch display IDs user has permission to access

Validations:

  • Must be an array of Integer
>>>

PUT api/v4/users/user_display_permissions/update_collaborators
Update user display permissions collaborators. Last update: 01/15/25

Request headers ↑

Only registered user can perform this action

Authentication - string - required
  Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body ↑

{
  "experience_type": "display",
  "user_ids": [1, 2],
  "display_id": 1,
  "display_name": "Display one"
}

Success response body ↑

{
  "message": "User display permissions updated",
  "list_for_add": [
      "John Doe"
  ],
  "list_for_remove": []
}

Params

Param name Description
user_ids
required

Array of user IDs

Validations:

  • Must be an array of Integer
experience_type
required

Type of experience: “display” or “touch”

Validations:

  • Must be a String
display_id
required

ID of display

Validations:

  • Must be a Integer
display_name
required

Name of display

Validations:

  • Must be a String
>>>

PUT api/v4/users/user_display_permissions/update_roles
Update user display permissions roles. Last update: 01/15/25

Request headers ↑

Only registered user can perform this action

Authentication - string - required
  Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body ↑

[
  {
    "user_id": 1,
    "display_role": "content_manager",
    "touch_role": "no_role"
  },
  {
    "user_id": 2,
    "display_role": "no_role"
  }
]

Success response body ↑

{
  "message": "User display permissions roles updated"
}

Params

Param name Description
users
required

Array of user objects with roles to update

Validations:

  • Must be an array of any type