Oracle Access Governance REST APIs

Act on one or more Approval Tasks.

post

/access-governance/access-controls/20250331/approvals

Request

Header Parameters

opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

One or more Approval Task decisions.

Root Schema : ApprovalDecisionDetails

Type: object

A list of Approval Task decisions.

Show Source

decisions(required): array decisions

List of Approval Task decisions.

{
    "type":"object",
    "required":[
        "decisions"
    ],
    "properties":{
        "decisions":{
            "type":"array",
            "description":"List of Approval Task decisions.",
            "items":{
                "$ref":"#/definitions/ApprovalDecision"
            }
        }
    },
    "description":"A list of Approval Task decisions."
}

Nested Schema : decisions

Type: array

List of Approval Task decisions.

Show Source

Array of: object ApprovalDecision

An individual Approval Task decision.

{
    "type":"array",
    "description":"List of Approval Task decisions.",
    "items":{
        "$ref":"#/definitions/ApprovalDecision"
    }
}

Nested Schema : ApprovalDecision

Type: object

An individual Approval Task decision.

Show Source

action(required): string

Allowed Values: [ "APPROVE", "REJECT" ]

APPROVE or REJECT
approvalTimeLimit: object ApprovalTimeLimit

Details about the approval time limit, when applicable. Only one of daysLimit, hoursLimit, or timeRangeLimit should be defined.
approvalTimeLimitType: string

Allowed Values: [ "INDEFINITELY", "NUMBER_OF_HOURS", "NUMBER_OF_DAYS", "DATE_TIME_RANGE", "EXTENSION" ]

Optional approval time limit type. When type is INDEFINITELY, approvalTimeLimit and extensionTimeLimit should be left undefined. When type is NUMBER_OF_HOURS, NUMBER_OF_DAYS, or DATE_TIME_RANGE, approvalTimeLimit should be provided. When type is EXTENSION, extensionTimeLimit should be provided.
comment(required): string

Justification for decision.
extensionTimeLimit: object ExtensionTimeLimit

Approval extension time limit definition as an end time.
taskId(required): string

The Approval Task ID for the decision.

{
    "type":"object",
    "required":[
        "action",
        "comment",
        "taskId"
    ],
    "properties":{
        "taskId":{
            "type":"string",
            "description":"The Approval Task ID for the decision."
        },
        "action":{
            "type":"string",
            "description":"APPROVE or REJECT",
            "enum":[
                "APPROVE",
                "REJECT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ApprovalDecisionType"
        },
        "comment":{
            "type":"string",
            "description":"Justification for decision."
        },
        "approvalTimeLimitType":{
            "type":"string",
            "description":"Optional approval time limit type.\nWhen type is INDEFINITELY, approvalTimeLimit and extensionTimeLimit should be left undefined.\nWhen type is NUMBER_OF_HOURS, NUMBER_OF_DAYS, or DATE_TIME_RANGE, approvalTimeLimit should be provided.\nWhen type is EXTENSION, extensionTimeLimit should be provided.\n",
            "enum":[
                "INDEFINITELY",
                "NUMBER_OF_HOURS",
                "NUMBER_OF_DAYS",
                "DATE_TIME_RANGE",
                "EXTENSION"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ApprovalTimeLimitType",
            "x-default-description":"INDEFINITELY"
        },
        "approvalTimeLimit":{
            "$ref":"#/definitions/ApprovalTimeLimit"
        },
        "extensionTimeLimit":{
            "$ref":"#/definitions/ExtensionTimeLimit"
        }
    },
    "description":"An individual Approval Task decision."
}

Nested Schema : ApprovalTimeLimit

Type: object

Details about the approval time limit, when applicable. Only one of daysLimit, hoursLimit, or timeRangeLimit should be defined.

Show Source

daysLimit: integer

Minimum Value: 1

Maximum Value: 365

Approval time limit definition in days.
hoursLimit: integer

Minimum Value: 1

Maximum Value: 24

Approval time limit definition in hours.
rangeLimit: object ApprovalTimeLimitRange

Approval time limit definition as a time range.

{
    "type":"object",
    "properties":{
        "daysLimit":{
            "type":"integer",
            "description":"Approval time limit definition in days.",
            "minimum":1,
            "maximum":365
        },
        "hoursLimit":{
            "type":"integer",
            "description":"Approval time limit definition in hours.",
            "minimum":1,
            "maximum":24
        },
        "rangeLimit":{
            "$ref":"#/definitions/ApprovalTimeLimitRange"
        }
    },
    "description":"Details about the approval time limit, when applicable. \nOnly one of daysLimit, hoursLimit, or timeRangeLimit should be defined.\n"
}

Nested Schema : ExtensionTimeLimit

Type: object

Approval extension time limit definition as an end time.

Show Source

timeExpires(required): string(date-time)

The extended expiration time as an RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "timeExpires"
    ],
    "properties":{
        "timeExpires":{
            "type":"string",
            "format":"date-time",
            "description":"The extended expiration time as an RFC3339 formatted datetime string."
        }
    },
    "description":"Approval extension time limit definition as an end time."
}

Nested Schema : ApprovalTimeLimitRange

Type: object

Approval time limit definition as a time range.

Show Source

timeExpires(required): string(date-time)

The expiration time as an RFC3339 formatted datetime string.
timeStarts(required): string(date-time)

The start time as an RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "timeExpires",
        "timeStarts"
    ],
    "properties":{
        "timeStarts":{
            "type":"string",
            "format":"date-time",
            "description":"The start time as an RFC3339 formatted datetime string."
        },
        "timeExpires":{
            "type":"string",
            "format":"date-time",
            "description":"The expiration time as an RFC3339 formatted datetime string."
        }
    },
    "description":"Approval time limit definition as a time range."
}

Response

Supported Media Types

application/json

200 Response

Successfully updated some or all of the approval tasks.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : ApprovalDecisionResults

Type: object

Response details of a set of Approval Task decisions.

Show Source

failures(required): array failures

List of failures generated while creating task actions.
status: string

Overall status of request.

{
    "type":"object",
    "required":[
        "failures"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall status of request."
        },
        "failures":{
            "type":"array",
            "description":"List of failures generated while creating task actions.",
            "items":{
                "$ref":"#/definitions/ApprovalDecisionFailure"
            }
        }
    },
    "description":"Response details of a set of Approval Task decisions."
}

Nested Schema : failures

Type: array

List of failures generated while creating task actions.

Show Source

Array of: object ApprovalDecisionFailure

Failure details of an Approval Task decision.

{
    "type":"array",
    "description":"List of failures generated while creating task actions.",
    "items":{
        "$ref":"#/definitions/ApprovalDecisionFailure"
    }
}

Nested Schema : ApprovalDecisionFailure

Type: object

Failure details of an Approval Task decision.

Show Source

errorMessage: string

Cause of the error.
taskId(required): string

Unique identifier of the task which failed to update.

{
    "type":"object",
    "required":[
        "taskId"
    ],
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Unique identifier of the task which failed to update."
        },
        "errorMessage":{
            "type":"string",
            "description":"Cause of the error."
        }
    },
    "description":"Failure details of an Approval Task decision."
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Examples

The following example shows how you can approve or reject an approval task for a request task. Replace placeholder values with actual values before running the sample command.

Before approving or rejecting an approval task for a request task, you need to run the following APIs to fetch the required data:

List Approvals - [GET] {BasePath}/approvals/{accessRequestId}
List Identities - [GET] {BasePath}/identities

cURL Request Example

curl -i -X POST \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
    "decisions": [
        {
            "taskId": "62555a75-30da-xxxxx-997d-xxxx",
            "action": "APPROVE",
            "comment": "Needed to perform the job"
        }
    ]
}' \
 '<${service-instance-url}/access-governance/access-controls/20250331/approvals>'

Submit the POST request

${service-instance-url}/access-governance/access-controls/${version}/approvals

Example Request Payload

{
    "decisions": [
        {
            "taskId": "62555a75-30da-xxxxx-997d-xxxx",
            "action": "APPROVE",
            "comment": "Needed to perform the job"
        }
    ]
}

Example of the Response Code

You'll receive 200 OK response along with the following response body:


{ "failures": [] }