Get an Identity

get

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

Returns identity details, including identity attributes with a given ID.

Request

Path Parameters
Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Back to Top

Response

Supported Media Types

200 Response

Retrieves the Identity with the given id.
Headers
  • For optimistic concurrency control. See `if-match`.
  • 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 : AccessGovernanceEntity
Type: object
An Access Governance Entity
Show Source

400 Response

Bad Request
Headers
  • 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

401 Response

Unauthorized
Headers
  • 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

404 Response

Not Found
Headers
  • 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

409 Response

Conflict
Headers
  • 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

429 Response

Too Many Requests
Headers
  • 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

500 Response

Internal Server Error
Headers
  • 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

Default Response

Unknown Error
Headers
  • 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
Back to Top

Examples

The following example shows how to retrieve details for a specific identity.

cURL Example - Without Query Parameters

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

Example of the Response Body

The following example shows the contents of the response body in JSON format, including details for an identity:

{
  "id": "globalId.OCI.xxxxx00000",
  "type": "IDENTITY",
  "name": "Bill.Clark@example.com",
  "timeCreated": "2025-01-21T01:05:35.558Z",
  "timeUpdated": "2025-01-21T01:05:35.558Z",
  "entityType": "USER",
  "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\":\"${service-instance}/admin/v1/Users/f58b6e9df2ff488bb765cc633f77d42f\",\"resourceType\":\"ACCOUNT\",\"value\":\"xxxxx00000\"},\"createdBy\":{\"displayName\":\"AG_Automation_Accessgovtest\",\"ref\":\"${service-instance}/admin/v1/Users/f58b6e9df2ff488bb765cc633f77d42f\",\"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\":1737421535558,\"lastModified\":1737421535558,\"version\":\"1\",\"location\":\"\"}}"
}
Back to Top