Update content role
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Update content role
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
PUT /teams/{userId}/content
Updates the content roles of the user.
Note
To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| content_permissions | Yes | object[] | Content permissions of the user. Note that the user can have multiple content permissions. |
| is_invitation_id | No | boolean | Applicable only for SSO users. If temporary invitation ID is passed as user ID, then set this to true. |
Body Parameters > content_permissions
| Parameter | Required | Type | Description |
|---|---|---|---|
| associated_content_role_id | Yes | string | The content role ID. To get the available roles in the project use the GET /roles endpoint. |
| access_scope | Yes | boolean | Applicable only for SSO users. If temporary invitation ID is passed as user ID, then set this to true. |
Body Parameters > content_permissions > access_scope
| Parameter | Required | Type | Description |
|---|---|---|---|
| access_level | Yes | number | The access level for the user. 0-None, 1-Category, 2-Version, 3-Project, 4-Language |
| categories | Conditionally | object[] | List of category scope objects. The field is required when access_level is set to 1-Category |
| project_versions | Conditionally | string[] | List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version. |
| languages | Conditionally | object[] | List of language scope objects. The field is required when access_level is set to 4-Language. |
Body Parameters > content_permissions > access_scope > categories
| Parameter | Required | Type | Description |
|---|---|---|---|
| category_id | Yes | string | The category ID to which the user should be given access. |
| project_version_id | Yes | string | The project version ID to which the category belongs. |
| language_code | Yes | string | The language to which the user should be given access. |
Body Parameters > content_permissions > access_scope > languages
| Parameter | Required | Type | Description |
|---|---|---|---|
| project_version_id | Yes | string | The project version ID to which the user should be given access. |
| language_code | Yes | string | The language to which the user should be given access. |
Sample Request
{
"associated_portal_role_id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
"is_invitation_id": false
}Sample Response
If the result property is true, then it indicates that the record has been successfully updated.
Was this article helpful?