Patch Role End Dates
patch
/iam/governance/selfservice/api/v1/roles/{roleid}/members
Update one or more user(s) with specified role's endDate. The logged in user should have the necessary privileges to perform the modify action.
Request
Supported Media Types
- application/json
Path Parameters
-
roleid(required): string
Entity Type possible values for RoleID
User's role end date to be updated.
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
404 Response
Requested entity not found
500 Response
Internal Server Error
Examples
cURL Example
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 -H "Content-Type: application/json" -H "X-Requested-By: <anyvalue>" -X PATCH -u username:password -d @patch.json https://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members
Example of PATCH Request Body
The following example shows the contents of the request body in JSON format.
{ "update" : [ { "userId": "82", "endDate": "2022-07-20T12:12:12Z" } ] }
Example of PATCH Response Body
The following example shows the contents of the response body in JSON format.
{ "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members" } ], "status": "SUCCESS" }