Jump to

• Request
• Response
• Examples

Patch 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

• uuid: string
  Unique User id. The unique user ID maps to the "usr_key" attribute of the user.

Body ()

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

{
    "properties":{
        "add":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchUserRequestDelete"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : add

Type: array

Show Source

• Array of: object Fields

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

Nested Schema : delete

Type: array

Show Source

• Array of: object PatchUserRequestDelete

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

Nested Schema : update

Type: array

Show Source

• Array of: object Fields

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

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : PatchUserRequestDelete

Type: object

Show Source

• name(optional): string

{
    "properties":{
        "name":{
            "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 : PatchUserByUserIdResponse

Type: object

Show Source

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

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

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

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"  -H "X-Requested-By: <anyvalue>"  -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"
      }
    ],
    "requestId": "10072"
  }
}

Back to Top