Oracle Access Governance REST APIs

List Identities

get

/access-governance/identities/20250331/identities

Get a list of Identities.

Request

Query Parameters

attributes: array[string]

Collection Format: multi

Maximum Number of Items: 5

The list of Attributes used to filter.
consumerFilter: string

A filter for consumer/workforce types.

Allowed Values: [ "CONSUMER", "WORKFORCE" ]
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

The list of Identities successfully queried.

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

Type: object

A list of the Access Governance Types.

Show Source

items(required): array items

List of Access Governance Types items.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Access Governance Types items.",
            "items":{
                "$ref":"#/definitions/AccessGovernanceEntity"
            }
        }
    },
    "description":"A list of the Access Governance Types."
}

Nested Schema : items

Type: array

List of Access Governance Types items.

Show Source

Array of: object AccessGovernanceEntity

The Access Governance Entity.

{
    "type":"array",
    "description":"List of Access Governance Types items.",
    "items":{
        "$ref":"#/definitions/AccessGovernanceEntity"
    }
}

Nested 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 a list of Identities 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'

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?consumerFilter=WORKFORCE'

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a list Workforce identities:

{
  "items": [
    {
      "id": "globalId.OCI.xxxxx00000",
      "type": "IDENTITY",
      "name": "Bill.Clark@example.com",
      "timeCreated": "2025-02-22T09:05:40.646Z",
      "timeUpdated": "2025-02-22T09:05:40.646Z",
      "entityType": "USER",
      "typeDetails": "${service-instance}/access-governance/identities/20250331/types/agcs.Identity",
      "attributes": [
        {
          "name": "agTerminated",
          "value": false
        }
      ],
      "value": "{\"name\":{\"formatted\":\"Clark Bill\",\"familyName\":\"Clark\",\"givenName\":\"Bill\"},\"userName\":\"Bill.Clark@example.com\",\"displayName\":\"Bill.Clark@example.com\",\"primaryEmail\":\"Bill.Clark@example.com\",\"organization\":{\"value\":\"organization.OCI.xxxxx00000\"},\"status\":\"Active\",\"emails\":[{\"primary\":false,\"secondary\":false,\"type\":\"recovery\",\"value\":\"Bill.Clark@example.com\",\"verified\":false},{\"primary\":true,\"secondary\":false,\"type\":\"work\",\"value\":\"Bill.Clark@example.com\",\"verified\":false}],\"addresses\":[],\"phoneNumbers\":[],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":0,\"customAttributes\":{}},\"agDelegation\":{\"hasDelegations\":false,\"customAttributes\":{}},\"agTerminate\":{\"terminated\":false,\"customAttributes\":{}},\"domainOCID\":\"ocid1.domain.oc1.xxxxx00000\",\"userNameDb2\":\"Bill.Clark@example.com\",\"userNameMysql\":\"BillClarkExampleCom\",\"userNameOracle\":\"Bill.Clark@example.com\",\"userNameMSSQl\":\"BillClarkExampleCom\",\"agOrganizations\":[],\"targetId\":\"xxxxx00000\",\"identityTargetId\":\"xxxxx00000\",\"compartmentId\":\"xxxxx00000\",\"domainId\":\"xxxxx00000\",\"region\":\"iad:us-ashburn-1\",\"customAttributes\":{\"targetAccounts\":[\"xxxxx00000\"],\"lastModifiedBy\":{\"displayName\":\"AG_Automation_Accessgovtest\",\"ref\":\"https://xxxxx00000\",\"resourceType\":\"ACCOUNT\",\"value\":\"xxxxx00000\"},\"createdBy\":{\"displayName\":\"AG_Automation_Accessgovtest\",\"ref\":\"https://xxxxx00000\",\"resourceType\":\"ACCOUNT\",\"value\":\"xxxxx00000\"},\"isCorrelated\":true,\"fullDN\":\"Bill.Clark@example.com_Tags\",\"domainName\":\"Default\",\"ocid\":\"ocid1.user.oc1.xxxxx00000\",\"compartmentOCID\":\"xxxxx00000\",\"compartmentName\":\"accessgovtest\",\"cloudAccountName\":\"accessgovtest\"},\"id\":\"xxxxx00000\",\"externalId\":\"xxxxx00000\",\"schemas\":[],\"meta\":{\"resourceType\":\"USER\",\"created\":1740215140646,\"lastModified\":1740215140646,\"version\":\"1\",\"location\":\"\"}}"
    }
  ]
}