Oracle Access Governance REST APIs

Gets a list of all Accounts

get

/access-governance/identities/20250331/identities/{identityId}/accounts

Returns a list of Accounts. Note keyword searches are limited to the name field and the first keyword query param.

Request

Path Parameters

identityId(required): string

Unique Identity id.

Query Parameters

keywordContains: array[string]

Collection Format: multi

Maximum Number of Items: 5

The list of keywords to filter on
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]

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.

Response

Supported Media Types

application/json

200 Response

A list of Account objects.

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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 : AccountCollection

Type: object

List of Accounts.

Show Source

items(required): array items

List of Accounts.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Accounts.",
            "items":{
                "$ref":"#/definitions/AccountSummary"
            }
        }
    },
    "description":"List of Accounts."
}

Nested Schema : items

Type: array

List of Accounts.

Show Source

Array of: object AccountSummary

Summary of the Account.

{
    "type":"array",
    "description":"List of Accounts.",
    "items":{
        "$ref":"#/definitions/AccountSummary"
    }
}

Nested Schema : AccountSummary

Type: object

Summary of the Account.

Show Source

accountStatus: string

Allowed Values: [ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ]

Status of the Account.
canDelete: boolean

Flag to show the deleting capability of the account.
canDisable: boolean

Flag to show the disabling capability of the account.
grantType: string

Grant Type of the Account.
id(required): string

Global Identity id of the account owner.
isPmProvisioned: boolean

Indicates if provisioned by PM.
isPolicyGrant: boolean

Indicates if the account is associated with any Policy.
name: string

Name of the account owner.
orchestratedSystem: object Info

Generic information object.
orchestratedSystemIdentityId: string

Orchestrated system Identity Id of the account owner.
orchestratedSystemType: string

Type of the Orchestrated System.
passwordChangeStatus: string

Password change status.
resourceName: string

Name of the Resource.
risk: string

Insights prediction value.
state: string

Allowed Values: [ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ]

State of the last processing event.
timeUpdated: string(date-time)

The time the Account was updated. An RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Global Identity id of the account owner."
        },
        "name":{
            "type":"string",
            "description":"Name of the account owner."
        },
        "passwordChangeStatus":{
            "type":"string",
            "description":"Password change status."
        },
        "isPmProvisioned":{
            "type":"boolean",
            "description":"Indicates if provisioned by PM."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the Account was updated. An RFC3339 formatted datetime string."
        },
        "resourceName":{
            "type":"string",
            "description":"Name of the Resource."
        },
        "orchestratedSystemIdentityId":{
            "type":"string",
            "description":"Orchestrated system Identity Id of the account owner."
        },
        "grantType":{
            "type":"string",
            "description":"Grant Type of the Account."
        },
        "orchestratedSystemType":{
            "type":"string",
            "description":"Type of the Orchestrated System."
        },
        "risk":{
            "type":"string",
            "description":"Insights prediction value."
        },
        "isPolicyGrant":{
            "type":"boolean",
            "description":"Indicates if the account is associated with any Policy."
        },
        "accountStatus":{
            "type":"string",
            "description":"Status of the Account.",
            "enum":[
                "ENABLED",
                "DISABLED",
                "ENABLE_IN_PROGRESS",
                "DISABLE_IN_PROGRESS",
                "DELETE_IN_PROGRESS",
                "ENABLE_FAILED",
                "DISABLE_FAILED",
                "DELETE_FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccountStatus",
            "x-default-description":"DISABLED"
        },
        "canDisable":{
            "type":"boolean",
            "description":"Flag to show the disabling capability of the account."
        },
        "canDelete":{
            "type":"boolean",
            "description":"Flag to show the deleting capability of the account."
        },
        "state":{
            "type":"string",
            "description":"State of the last processing event.",
            "enum":[
                "ENABLED",
                "DISABLED",
                "ENABLE_IN_PROGRESS",
                "DISABLE_IN_PROGRESS",
                "DELETE_IN_PROGRESS",
                "ENABLE_FAILED",
                "DISABLE_FAILED",
                "DELETE_FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccountStatus",
            "x-default-description":"DISABLED"
        },
        "orchestratedSystem":{
            "$ref":"#/definitions/Info"
        }
    },
    "description":"Summary of the Account."
}

Nested Schema : Info

Type: object

Generic information object.

Show Source

displayName: string

Display Name of the entity.
id: string

id of the entity.
name: string

name of the entity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic information object."
}

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

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 to retrieve a list of accounts by submitting a GET request.

cURL Example - Without Query Parameters

curl -i -X \
 GET \
 -H \
 "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/identities/${versionId}/identities/${IdentityId}/accounts'

cURL Example - With Query Parameters

cURL command to restrict the data and include only Workforce Identities.

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/identities/${versionId}/identities/${IdentityId}/accounts?keywordContains=Bill'

Example of the Response Body

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

{
  "items": [
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.55045.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "passwordChangeStatus": "Never Attempted",
      "isPmProvisioned": true,
      "timeUpdated": null,
      "resourceName": "Database Access Management",
      "orchestratedSystemIdentityId": "targetId.account.ICF.da7efca4-xxxx-4d4f-8ad3-c55ac9362de6.a285ce40190faf23401a9e2c3f35682c",
      "grantType": "DIRECT",
      "orchestratedSystemType": "ICF",
      "risk": "1",
      "isPolicyGrant": false,
      "accountStatus": "ENABLED",
      "canDisable": true,
      "canDelete": true,
      "state": null,
      "orchestratedSystem": {
        "id": "da7efca4-xxxx-4d4f-8ad3-c55ac9362de6",
        "name": "Database Access Management",
        "displayName": null
      }
    },
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.55045.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "passwordChangeStatus": "Not Applicable",
      "isPmProvisioned": false,
      "timeUpdated": null,
      "resourceName": "database-tenancy",
      "orchestratedSystemIdentityId": "targetId.account.OCI.bd49ff2a-xxxx-4242-8975-9ba235fbb0ec.fa8db78c5e0b4395354ca399728604fa",
      "grantType": "DIRECT",
      "orchestratedSystemType": "OCI",
      "risk": "1",
      "isPolicyGrant": false,
      "accountStatus": "ENABLED",
      "canDisable": true,
      "canDelete": false,
      "state": null,
      "orchestratedSystem": {
        "id": "bd49ff2a-xxxx-4242-8975-9ba235fbb0ec",
        "name": "Database Performance Optimization OCI",
        "displayName": null
      }
    }
  ]
}