Jump to

• Request
• Response
• Examples

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: string
  Entity Type possible values for RoleID

Body ()

User's role end date to be updated.

Root Schema : RoleEndDatePatchRequest

Type: object

Show Source

• update(optional): array update

{
    "properties":{
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UpdateRoleEndDateRequest"
            }
        }
    }
}

Nested Schema : update

Type: array

Show Source

• Array of: object UpdateRoleEndDateRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UpdateRoleEndDateRequest"
    }
}

Nested Schema : UpdateRoleEndDateRequest

Type: object

Show Source

• endDate(optional): string
• userId(optional): string

{
    "properties":{
        "userId":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : RoleEndDatePatchResponse

Type: object

Show Source

• links(optional): array links
• status(optional): string

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top

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"
}

Back to Top