Patch users
patch
/iam/governance/selfservice/api/v1/users
Updates the one or more user(s) with list of user attributes specified in the request payload. The user should have the necessary privileges to perform the modify user action.
Request
Supported Media Types
- application/json
List of attributes of users to be updated. "id" is a mandatory field. The "id" field maps to the usr_key attribute of the user.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
403 Response
Forbidden
404 Response
Resource not found
500 Response
Internal Server Error
Examples
This example demonstrates the ability to patch multiple users with a single request. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X PATCH -u username:password -d @patch.json https://pseudo.com/iam/governance/selfservice/api/v1/users
Example of PATCH Request Body
The following example shows the contents of the request body in JSON format.
{
"users": [
{
"id": "18008",
"requestId": "Req1",
"add": [
{
"name": "Last Name",
"value": "updateed12345"
}
],
"delete": [
{
"name": "First Name"
}
],
"update": [
{
"name": "Display Name",
"value": "supriya12345"
}
]
},
{
"id": "18009",
"requestId": "Req2",
"add": [
{
"name": "Last Name",
"value": "updateed12345"
}
],
"delete": [
{
"name": "First Name"
}
],
"update": [
{
"name": "Display Name",
"value": "supriya12345"
}
]
}
]
}
Example of PATCH Response Body
The following example shows the contents of the response body in JSON format:
{
"users": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18008"
}
],
"requestId": "Req1",
"id": "18008",
"status": " SUCCESS",
"request": {
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10073"
}
],
"id": "10073"
}
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18009"
}
],
"requestId": "Req2",
"id": "18009",
"status": " SUCCESS",
"request": {
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10074"
}
],
"id": "10074"
}
}
]
}