Jump to

• Request
• Response
• Examples

Retry Access Bundle provisioning in bulk

post

/access-governance/access-controls/20250331/accessBundles/retry

Retry Access Bundle provisioning in bulk.

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.

Body ()

Details used to bulk retry access bundles.

Root Schema : RetryAccessBundleBulkDetails

Type: object

The information used to bulk retry Access Bundles.

Show Source

• excludedItems: array excludedItems
  List of (globalIdentityId, accessBundleId) pairs to exclude.
• filterCriteria: object AdvancedFilter
  Advanced Filter object.
• keywordContains: array keywordContains
  The list of keyword search strings.
• retryItems: array retryItems
  List of (globalIdentityId, accessBundleId) pairs to retry.
• targetId(required): string
  Target Identifier that the Access Bundle is associated with.

{
    "type":"object",
    "required":[
        "targetId"
    ],
    "properties":{
        "targetId":{
            "type":"string",
            "description":"Target Identifier that the Access Bundle is associated with."
        },
        "retryItems":{
            "type":"array",
            "description":"List of (globalIdentityId, accessBundleId) pairs to retry.",
            "items":{
                "$ref":"#/definitions/AccessBundleRetryItem"
            }
        },
        "excludedItems":{
            "type":"array",
            "description":"List of (globalIdentityId, accessBundleId) pairs to exclude.",
            "items":{
                "$ref":"#/definitions/AccessBundleRetryItem"
            }
        },
        "keywordContains":{
            "type":"array",
            "description":"The list of keyword search strings.",
            "items":{
                "type":"string"
            }
        },
        "filterCriteria":{
            "$ref":"#/definitions/AdvancedFilter"
        }
    },
    "description":"The information used to bulk retry Access Bundles."
}

Nested Schema : excludedItems

Type: array

List of (globalIdentityId, accessBundleId) pairs to exclude.

Show Source

• Array of: object AccessBundleRetryItem
  Represents a pair of globalIdentityId and accessBundleId used for retry operations.

{
    "type":"array",
    "description":"List of (globalIdentityId, accessBundleId) pairs to exclude.",
    "items":{
        "$ref":"#/definitions/AccessBundleRetryItem"
    }
}

Nested Schema : AdvancedFilter

Type: object

Advanced Filter object.

Show Source

• bindingOperator: string
  Allowed Values: [ "ALL", "ANY" ]

  Binding operator.
• conditions: array conditions
  Filter condition.

{
    "type":"object",
    "properties":{
        "bindingOperator":{
            "type":"string",
            "description":"Binding operator.",
            "enum":[
                "ALL",
                "ANY"
            ],
            "x-obmcs-top-level-enum":"#/definitions/BindingOperators"
        },
        "conditions":{
            "type":"array",
            "description":"Filter condition.",
            "items":{
                "$ref":"#/definitions/Conditions"
            }
        }
    },
    "description":"Advanced Filter object."
}

Nested Schema : keywordContains

Type: array

The list of keyword search strings.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of keyword search strings.",
    "items":{
        "type":"string"
    }
}

Nested Schema : retryItems

Type: array

List of (globalIdentityId, accessBundleId) pairs to retry.

Show Source

• Array of: object AccessBundleRetryItem
  Represents a pair of globalIdentityId and accessBundleId used for retry operations.

{
    "type":"array",
    "description":"List of (globalIdentityId, accessBundleId) pairs to retry.",
    "items":{
        "$ref":"#/definitions/AccessBundleRetryItem"
    }
}

Nested Schema : AccessBundleRetryItem

Type: object

Represents a pair of globalIdentityId and accessBundleId used for retry operations.

Show Source

• accessBundleId(required): string
  Access Bundle ID.
• globalIdentityId(required): string
  Global Identity ID.

{
    "type":"object",
    "required":[
        "accessBundleId",
        "globalIdentityId"
    ],
    "properties":{
        "globalIdentityId":{
            "type":"string",
            "description":"Global Identity ID."
        },
        "accessBundleId":{
            "type":"string",
            "description":"Access Bundle ID."
        }
    },
    "description":"Represents a pair of globalIdentityId and accessBundleId used for retry operations."
}

Nested Schema : conditions

Type: array

Filter condition.

Show Source

• Array of: object Conditions
  Filter condition.

{
    "type":"array",
    "description":"Filter condition.",
    "items":{
        "$ref":"#/definitions/Conditions"
    }
}

Nested Schema : Conditions

Type: object

Filter condition.

Show Source

• name: string
  Attribute Name.
• operator: string
  Allowed Values: [ "EQ", "NE", "GT", "LT", "GTE", "LTE", "IN", "NIN", "CON", "NCON", "BW", "NBW", "EW", "NEW", "BTW", "BEFORE", "AFTER", "TILL", "FROM" ]

  Operator.
• type: string
  Attribute Data Type.
• value: array value
  Attribute Value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute Name."
        },
        "operator":{
            "type":"string",
            "description":"Operator.",
            "enum":[
                "EQ",
                "NE",
                "GT",
                "LT",
                "GTE",
                "LTE",
                "IN",
                "NIN",
                "CON",
                "NCON",
                "BW",
                "NBW",
                "EW",
                "NEW",
                "BTW",
                "BEFORE",
                "AFTER",
                "TILL",
                "FROM"
            ],
            "x-obmcs-top-level-enum":"#/definitions/Operators"
        },
        "value":{
            "type":"array",
            "description":"Attribute Value.",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "type":"string",
            "description":"Attribute Data Type."
        }
    },
    "description":"Filter condition."
}

Nested Schema : value

Type: array

Attribute Value.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attribute Value.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Bulk Access bundle retries was successfully done.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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.

Body ()

Root Schema : RetryAccessBundlesBulkResults

Type: object

The result of the RetryBulkAccessBundleDetails operation.

Show Source

• message: string
  Message of the operation.
• result(required): string
  Allowed Values: [ "RETRY_IN_PROGRESS", "RETRY_FAILED" ]

  The result of the bulk retry operation.

{
    "type":"object",
    "required":[
        "result"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Message of the operation."
        },
        "result":{
            "type":"string",
            "description":"The result of the bulk retry operation.",
            "enum":[
                "RETRY_IN_PROGRESS",
                "RETRY_FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/BulkRetryResult"
        }
    },
    "description":"The result of the RetryBulkAccessBundleDetails operation."
}

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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."
}

Back to Top

Examples

The following example shows how to retry failed provisioning of access bundles in bulk for identities.

cURL Request Example

curl -i -X POST \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
  "targetId": "98360b08-c107-4fc4-93d3-xxxa1c",
  "retryItems": [
    {
      "globalIdentityId": "globalId.ICF.224d20ff-5187-4301-a47bxxxxx132df95053b2879a66e61",
      "accessBundleId": "b0610b9f-3883-45a1-9906-54xxxx"
    }
  ],
  "excludedItems": []
}'\
 '<${service-instance-url}/access-governance/access-controls/${versionId}/accessBundles/retry' >'

Example Request Payload

{
  "targetId": "98360b08-c107-4fc4-93d3-xxxa1c",
  "retryItems": [
    {
      "globalIdentityId": "globalId.ICF.224d20ff-5187-4301-a47bxxxxx132df95053b2879a66e61",
      "accessBundleId": "b0610b9f-3883-45a1-9906-54xxxx"
    }
  ],
  "excludedItems": []
}

Example of the Response Code

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

{
"message": "Access bundle retry is in progress. Updates will be available shortly.",
"result": "RETRY_IN_PROGRESS"
}

Back to Top