Jump to

• Request
• Response
• Examples

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

Body ()

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.

Root Schema : PatchUsersRequest

Type: object

Show Source

• users(optional): array users

{
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchUserRequest"
            }
        }
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object PatchUserRequest

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

Nested Schema : PatchUserRequest

Type: object

Show Source

• add(optional): array add
• delete(optional): array delete
• id(optional): string
• requestId(optional): string
• update(optional): array update

{
    "properties":{
        "id":{
            "type":"string"
        },
        "requestId":{
            "type":"string"
        },
        "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 : PatchUsersResponse

Type: object

Show Source

• id(optional): string
• links(optional): array links
• request(optional): object RequestInfo
• requestId(optional): string
• status(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "request":{
            "$ref":"#/definitions/RequestInfo"
        },
        "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 : RequestInfo

Type: object

Show Source

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

{
    "properties":{
        "id":{
            "type":"string"
        },
        "links":{
            "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"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

500 Response

Internal Server Error

Back to Top

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"  -H "X-Requested-By: <anyvalue>"  -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",
      "add": [
        {
          "name": "Last Name",
          "value": "updateed12345"
        }
      ],
      "delete": [
        {
          "name": "First Name"
        }
      ],
      "update": [
        {
          "name": "Display Name",
          "value": "supriya12345"
        }
      ]
    },
    {
      "id": "18009",
      "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"
        }
      ],
      "id": "18008",
      "status": " SUCCESS",
      "request": {
        "links": [
          {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10073"
          }
        ],
        "requestId": "10073"
      }
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18009"
        }
      ],
      "id": "18009",
      "status": " SUCCESS",
      "request": {
        "links": [
          {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10074"
          }
        ],
        "requestId": "10074"
      }
    }
  ]
}

Back to Top