This web service modifies the tags that an administrator has manually assigned to a user.
This web service does not update user roles originating from a post-authentication script.
| Method | Endpoint |
|---|---|
PUT |
|
| Path parameter | Type | Description |
|---|---|---|
{userId} |
String | The user's identifier. See the List users or Search users web services to find a user's ID. |
Request example
The following lines show an example of a JSON request body:
{
"manualTags": [
"tag1"
]
}
This replaces all previous values with the values of the request.
| Field | Type | Required? | Description |
|---|---|---|---|
manualtags |
Array | Yes | The tags that an administrator has assigned manually to the user. |
| Return code | Description |
|---|---|
200 OK |
The request is valid. |
400 BAD REQUEST |
A tag is blank. |
401 UNAUTHORIZED |
The authorization header is absent or invalid. |
403 FORBIDDEN |
The user or API key does not have the ADMIN or USERS_ADMIN role. |
404 NOT FOUND |
No user exists with this ID. |
For a comprehensive list of all possible return codes, see Return codes.
Response body
The following lines show an example of a JSON response body:
{
"id": "6d346375-8f99-4248-acf0-ec84ebeb60cc",
"manualTags": [
"tag1",
"tag3"
],
"authenticationTags": []
}
| Field | Type | Description |
|---|---|---|
id |
String | The user's identifier. |
manualtags |
Array | The tags that an administrator has assigned manually to the user. |
authenticationTags |
Array | The tags provided by a post-authentication script. |