Jump to

• Request
• Response
• Examples

Patch the proxies for user based on user id

patch

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

The proxies can be added, updated and deleted. The same proxy id cannot be added in the update and the delete sections. Same user can be added as a proxy for different time intervals.

Request

Supported Media Types

• application/json

Path Parameters

• uuid: string
  Unique identifier of the User to add, update or delete proxies.

Body ()

Root Schema : UserProxiesPatchRequest

Type: object

Show Source

• user(optional): object PatchUsersProxiesRequestInner

{
    "properties":{
        "user":{
            "$ref":"#/definitions/PatchUsersProxiesRequestInner"
        }
    }
}

Nested Schema : PatchUsersProxiesRequestInner

Type: object

Show Source

• add(optional): array add
• delete(optional): array delete
• update(optional): array update

{
    "properties":{
        "add":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AddUserProxyRequest"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UpdateUserProxyRequest"
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeleteUserProxyRequest"
            }
        }
    }
}

Nested Schema : add

Type: array

Show Source

• Array of: object AddUserProxyRequest

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

Nested Schema : delete

Type: array

Show Source

• Array of: object DeleteUserProxyRequest

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

Nested Schema : update

Type: array

Show Source

• Array of: object UpdateUserProxyRequest

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

Nested Schema : AddUserProxyRequest

Type: object

Show Source

• endDate(optional): string
• requestId(optional): string
• startDate(optional): string
• userid(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

Nested Schema : DeleteUserProxyRequest

Type: object

Show Source

• id(optional): string
• requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : UpdateUserProxyRequest

Type: object

Show Source

• endDate(optional): string
• id(optional): string
• parentUserId(optional): string
• requestId(optional): string
• startDate(optional): string
• userid(optional): string
• userkey(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "userkey":{
            "type":"string"
        },
        "parentUserId":{
            "type":"string"
        },
        "startDate":{
            "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 : PatchUsersProxiesResponse

Type: object

Show Source

• user(optional): object PatchUsersProxiesResponseInner

{
    "properties":{
        "user":{
            "$ref":"#/definitions/PatchUsersProxiesResponseInner"
        }
    }
}

Nested Schema : PatchUsersProxiesResponseInner

Type: object

Show Source

• add(optional): array add
• delete(optional): array delete
• update(optional): array update

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

Nested Schema : add

Type: array

Show Source

• Array of: object AddUpdateUserProxyResponse

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

Nested Schema : delete

Type: array

Show Source

• Array of: object DeleteUserProxyResponse

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

Nested Schema : update

Type: array

Show Source

• Array of: object AddUpdateUserProxyResponse

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

Nested Schema : AddUpdateUserProxyResponse

Type: object

Show Source

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

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "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"
        }
    }
}

Nested Schema : DeleteUserProxyResponse

Type: object

Show Source

• requestId(optional): string
• status(optional): string
• userid(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "status":{
            "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 add/update/delete a user proxy list. 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/24/proxies

Example of PATCH Request Body

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

{
  "user": {
    "add": [
      {
        "userid": "17",
        "startDate": "2019-03-19T08:00:00Z",
        "endDate": "2019-03-19T12:00:00Z"
      },
      {
        "userid": "17",
        "startDate": "2019-03-22T08:00:00Z",
        "endDate": "2019-03-25T12:00:00Z"
      }
    ]
  }
}

Example of PATCH Response Body

The following example shows the contents of the response body in JSON format:

{
    "user": {
        "links": [
            {
                "rel": "self",
                "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24/proxies"
            }
        ],
        "add": [
            {
                "links": [
                    {
                        "rel": "self",
                        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                    }
                ],
                "requestId": 0,
                "id": "3",
                "userid": "17",
                "status": "SUCCESS",
                "description": "NOT_STARTED",
                "relationship": "MANAGER"
            },
            {
                "links": [
                    {
                        "rel": "self",
                        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                    }
                ],
                "requestId": 0,
                "id": "4",
                "userid": "17",
                "status": "SUCCESS",
                "description": "NOT_STARTED",
                "relationship": "MANAGER"
            }
        ]
    }
}

Back to Top