Oracle Access Governance REST APIs

Get an Account

get

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

Gets an Account by identifier.

Request

Path Parameters

accountId(required): string

Unique Account id.
identityId(required): string

Unique Identity id.

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

Retrieves the Account for the given Account Id.

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 : AccessGovernanceEntity

Type: object

The Access Governance Entity.

Show Source

attributes: array attributes

Optional fields for entities.
entityType(required): string

Allowed Values: [ "IDENTITY_GROUP", "GROUP", "META_POLICY", "TARGET_POLICY", "PM_ROLE", "ROLE", "ORGANIZATION", "IDENTITY_COLLECTION", "TARGET", "CLOUD_ACCOUNT", "APPLICATION", "RESOURCES", "PERMISSIONS", "PERMISSION_ASSIGNMENTS", "PERMISSION_TYPE", "ACCOUNT", "POLICY", "IDENTITY", "RESOURCE_ENTITY", "RESOURCE", "PERMISSION_COLLECTION", "PERMISSION_REQUEST", "GLOBAL_IDENTITY_COLLECTION", "AG_ORGANIZATION", "ACTIVE_GROUP", "CONSUMER_GROUP", "ACCESS_BUNDLE", "CLOUD_RESOURCE", "USER", "WORKLOAD", "ACCESS_GUARDRAIL" ]

The Source Entity Type in Access Governance.
id(required): string

The Id for the Access Governance Entity.
name(required): string

The Name for the Access Governance Type.
timeCreated(required): string(date-time)

Time when the Access Bundle was created. An RFC3339 formatted datetime string.
timeUpdated(required): string(date-time)

Time when the Access Bundle was last updated. An RFC3339 formatted datetime string.
type(required): string

Allowed Values: [ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ]

The Access Governance Entity Type.
typeDetails: string

A resource that describes the type schema.
value(required): string

The json schema for the Access Governance Type.

{
    "type":"object",
    "required":[
        "entityType",
        "id",
        "name",
        "timeCreated",
        "timeUpdated",
        "type",
        "value"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for the Access Governance Entity."
        },
        "type":{
            "type":"string",
            "description":"The Access Governance Entity Type.",
            "enum":[
                "IDENTITY",
                "IDENTITY_COLLECTION",
                "ORGANIZATION",
                "ROLE",
                "PERMISSION",
                "ACCESS_BUNDLE",
                "POLICY",
                "RESOURCE",
                "CLOUD_RESOURCE",
                "ACCOUNT",
                "OWNERSHIP",
                "APPROVAL_PROCESS",
                "TARGET",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityType"
        },
        "name":{
            "type":"string",
            "description":"The Name for the Access Governance Type."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string."
        },
        "entityType":{
            "type":"string",
            "description":"The Source Entity Type in Access Governance.",
            "enum":[
                "IDENTITY_GROUP",
                "GROUP",
                "META_POLICY",
                "TARGET_POLICY",
                "PM_ROLE",
                "ROLE",
                "ORGANIZATION",
                "IDENTITY_COLLECTION",
                "TARGET",
                "CLOUD_ACCOUNT",
                "APPLICATION",
                "RESOURCES",
                "PERMISSIONS",
                "PERMISSION_ASSIGNMENTS",
                "PERMISSION_TYPE",
                "ACCOUNT",
                "POLICY",
                "IDENTITY",
                "RESOURCE_ENTITY",
                "RESOURCE",
                "PERMISSION_COLLECTION",
                "PERMISSION_REQUEST",
                "GLOBAL_IDENTITY_COLLECTION",
                "AG_ORGANIZATION",
                "ACTIVE_GROUP",
                "CONSUMER_GROUP",
                "ACCESS_BUNDLE",
                "CLOUD_RESOURCE",
                "USER",
                "WORKLOAD",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/SourceEntityTypes"
        },
        "typeDetails":{
            "type":"string",
            "description":"A resource that describes the type schema."
        },
        "attributes":{
            "type":"array",
            "description":"Optional fields for entities.",
            "items":{
                "$ref":"#/definitions/AttributeOptionalField"
            }
        },
        "value":{
            "type":"string",
            "description":"The json schema for the Access Governance Type."
        }
    },
    "description":"The Access Governance Entity."
}

Nested Schema : attributes

Type: array

Optional fields for entities.

Show Source

Array of: object AttributeOptionalField

An optional Attribute field.

{
    "type":"array",
    "description":"Optional fields for entities.",
    "items":{
        "$ref":"#/definitions/AttributeOptionalField"
    }
}

Nested Schema : AttributeOptionalField

Type: object

An optional Attribute field.

Show Source

name: string

name of the field.
value: object value

Value of the field.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the field."
        },
        "value":{
            "type":"object",
            "description":"Value of the field.",
            "properties":{
            }
        }
    },
    "description":"An optional Attribute field."
}

Nested Schema : value

Type: object

Value of the field.

Show Source

{
    "type":"object",
    "description":"Value of the field.",
    "properties":{
    }
}

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 to retrieve identity account details including account attributes. Use orchestratedSystemIdentityId as the account ID.

cURL Example GET

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

Example of the Response Code

You'll receive a 200 OK Response Code with the following Response body:

{
  "id": "targetId.account.ICF.da7efca4-xxxx-4d4f-8ad3-c55ac9362de6.a285ce40190faf23401a9e2c3f35682c",
  "type": "ACCOUNT",
  "name": "Bill Clark",
  "timeCreated": "2024-11-08T11:22:55.789Z",
  "timeUpdated": "2024-11-08T11:22:55.789Z",
  "entityType": "ACCOUNT",
  "typeDetails": "https://database-access-management.api.access-governance.oci.oc-test.com/access-governance/identities/20250331/types/agcs.Account?orchestratedSystemId=da7efca4-xxxx-4d4f-8ad3-c55ac9362de6",
  "attributes": [
    {
      "name": "resourceName",
      "value": "Database Access Management"
    },
    {
      "name": "resourceTypeName",
      "value": "DBUM"
    },
    {
      "name": "connectedSystem",
      "value": "Database Access Management"
    },
    {
      "name": "targetType",
      "value": "ICF"
    },
    {
      "name": "targetId",
      "value": "da7efca4-xxxx-4d4f-8ad3-c55ac9362de6"
    }
  ],
  "value": "{\n  \"targetId\": \"da7efca4-xxxx-4d4f-8ad3-c55ac9362de6\",\n  \"identityGlobalId\": \"globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.55045.02e36bbb4b201421b44aa046b3ceb16a\",\n  \"resourcesId\": \"resource.ICF.da7efca4-xxxx-4d4f-8ad3-c55ac9362de6.153c14344ccda28d2c2106cc5b5a8e4d\",\n  \"identityAccountType\": \"ACCOUNT\",\n  \"name\": \"Bill Clark\",\n  \"status\": \"true\",\n  \"riskSummary\": 0,\n  \"userLogin\": \"Bill Clark\",\n  \"customAttributes\": {\n    \"operationType\": \"CREATE_OR_UPDATE\",\n    \"authenticationType\": \"EXTERNAL\",\n    \"globalDN\": \"cn\\\\u003dBILLCLARK,cn\\\\u003dadmin,dc\\\\u003dcorp,dc\\\\u003dCOM\",\n    \"defaultTablespace\": \"USERS\",\n    \"temporaryTablespace\": \"TEMP\",\n    \"profileName\": \"DEFAULT\",\n    \"accountStatus\": \"OPEN\",\n    \"roles\": [\n      { \"element\": { \"UID\": \"DV_OWNER\", \"roleAdminOption\": \"NO\" } },\n      { \"element\": { \"UID\": \"DV_GOLDENGATE_REDO_ACCESS\", \"roleAdminOption\": \"NO\" } }\n    ]\n  },\n  \"id\": \"targetId.account.ICF.da7efca4-xxxx-4d4f-8ad3-c55ac9362de6.a285ce40190faf23401a9e2c3f35682c\",\n  \"externalId\": \"Bill Clark\",\n  \"schemas\": [],\n  \"meta\": {\n    \"resourceType\": \"ACCOUNT\",\n    \"created\": 1731064975789,\n    \"lastModified\": 1731064975789,\n    \"version\": \"1\",\n    \"location\": \"\"\n  }\n}"
}