REST API for Oracle Identity Governance Self Service

Update Request Based on Request ID

put

/iam/governance/selfservice/api/v1/requests/{reqid}

Updates the specified request. The Oracle Identity Manager request id should be specified in the path parameter. The attributes to update for the request should be provided in the payload. The request data can updated or the request status can be updated. Based on the type of action attribute provided the SOA or OIM action is executed. Here the action could be APPROVE, RELEASE, RESUME, REASSIGN, REJECT, ESCALATE, SUSPEND, WITHDRAW, CLAIM, SAVE, CREATESUBTASK, SKIPASSIGNMENT, CLOSE. As an option a taskId can be provided with the request to exclusively perform the operation on the specific task. If the taskId is not provided then the first task in the list will be picked for the operation requested.

Request

Supported Media Types

application/json

Path Parameters

reqid(required): string

Request ID

List of attributes of request to be updated

Root Schema : ReqUpdateRequest

Type: object

Show Source

action: string
actionComment: string
assignees: array assignees
reqTargetEntities: array reqTargetEntities
requestId: string
taskId: string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "actionComment":{
            "type":"string"
        },
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PendingApprovalsAssigneeNames"
            }
        },
        "reqTargetEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reqTargetEntityRequestPayload"
            }
        }
    }
}

Nested Schema : assignees

Type: array

Show Source

Array of: object PendingApprovalsAssigneeNames

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

Nested Schema : reqTargetEntities

Type: array

Show Source

Array of: object reqTargetEntityRequestPayload

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

Nested Schema : PendingApprovalsAssigneeNames

Type: object

Show Source

name: string
type: string

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

Nested Schema : reqTargetEntityRequestPayload

Type: object

Show Source

appFormData: array appFormData
catalogId: string
entityId: string
entityName: string
entityType: string
parentAccountId: integer
parentAccountName: string

{
    "properties":{
        "entityName":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "catalogId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "parentAccountId":{
            "type":"integer"
        },
        "parentAccountName":{
            "type":"string"
        },
        "appFormData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : appFormData

Type: array

Show Source

Array of: object Fields

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

Nested Schema : Fields

Type: object

Show Source

name: string
value: string

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

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : ReqUpdateResponseEntity

Type: object

Show Source

id: string
links: array links
reason: string
requestId: string
status: string

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

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

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

500 Response

Internal Server Error

Examples

This example demonstrates the ability to approve a pending request.

cURL Example

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/requests/1235

Example of PUT Request Body

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

{
  "requestId": "coder-1001",
  "taskId": "2c91aeca-9169-47fd-847f-466763af278a",
  "action": "approve"
}

Example of PUT 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/requests/1235"
    }
  ],
  "id": "1235",
  "requestId": "coder-1001",
  "status": "SUCCESS"
}