REST API for Oracle Identity Governance Self Service

  1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Users

Update User based on user id

patch

/iam/governance/selfservice/api/v1/users/{uuid}

Updates the user attributes specified in the request payload for the specified user. A request is raised in Oracle Identity Manager for the modify user operation. The details of the request is captured in the response payload.

Request

Supported Media Types
  • application/json
Path Parameters
  • Unique User id. The unique user ID maps to the "usr_key" attribute of the user.
Body (
  1. PatchUsersByUserIdRequest
)
Attributes of user to be updated. The attribute names have to be mentioned correctly. In case of any errors in the attribute name Oracle Identity Manager throws an exception.
Root Schema : PatchUsersByUserIdRequest
Type: object
Show Source
  • add(optional): array add
  • delete(optional): array delete
  • update(optional): array update
Nested Schema : add
Type: array
Show Source
Nested Schema : delete
Type: array
Show Source
Nested Schema : update
Type: array
Show Source
Nested Schema : Fields
Type: object
Show Source
  • name(optional): string
  • value(optional): string
Nested Schema : PatchUserRequestDelete
Type: object
Show Source
  • name(optional): string
Back to Top

Response

Supported Media Types
  • application/json

200 Response

Successful
Headers
Body (
  1. PatchUserByUserIdResponse
)
Root Schema : PatchUserByUserIdResponse
Type: object
Show Source
  • id(optional): string
  • links(optional): array links
  • status(optional): string
Nested Schema : LinkDataInstances
Type: object
Show Source
  • href(optional): string
  • rel(optional): string

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error
Back to Top

Examples

This example demonstrates the ability to patch a single user. 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/18008

Example of PATCH Request Body

The following example shows the contents of the request body in JSON format.

{
  "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:

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18008"
    }
  ],
  "id": "18008",
  "status": "SUCCESS",
  "request": {
    "links": [
      {
        "rel": "self",
        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10072"
      }
    ],
    "id": "10072"
  }
}
Back to Top