Oracle Access Governance REST APIs

Gets a list of all identities that are part of organization

get

/access-governance/service-administration/20250331/organizations/{organizationId}/members

Returns list of members for a given organization with support for pagination.

Request

Path Parameters

organizationId(required): string

The unique id for an Organization. Available values can be found using the ListOrganizations operation.

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

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.

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 members of given Organization was 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", "CAMPAIGN", "UNKNOWN_SOURCE_ENTITY_TYPE" ]

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", "ROLE_APPROVERS", "ACCESS_BUNDLE_APPROVERS", "TARGET_IDENTITY", "CAMPAIGN", "TARGET_PERMISSION" ]

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",
                "ROLE_APPROVERS",
                "ACCESS_BUNDLE_APPROVERS",
                "TARGET_IDENTITY",
                "CAMPAIGN",
                "TARGET_PERMISSION"
            ],
            "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",
                "CAMPAIGN",
                "UNKNOWN_SOURCE_ENTITY_TYPE"
            ],
            "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 for an organization. You can use the member listing for an organization to submit an access request limited to members of an organization.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${si}/access-governance/service-administration/${version}/organizations/${organizationId}/members'

Example of the Response Body

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

{
  "items": [
    {
      "id": "globalId.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "type": "IDENTITY",
      "name": "JDOE@EXAMPLE.COM",
      "timeCreated": "2024-09-09T12:09:09.126Z",
      "timeUpdated": "2024-09-09T12:09:09.126Z",
      "isRuleBased": false,
      "entityType": "USER",
      "value": "{\"name\":{\"familyName\":\"Doe\",\"givenName\":\"John\"},\"userName\":\"JDOE@EXAMPLE.COM\",\"displayName\":\"John Doe\",\"description\":\"Sample description\",\"primaryEmail\":\"jdoe@example.com\",\"userType\":\"Contractor\",\"organization\":{\"value\":\"organization.xx.xx.xx.xx.xx\",\"displayName\":\"Engineering\"},\"status\":\"Active\",\"jobCode\":\"JC001\",\"state\":\"CA\",\"risk\":5,\"location\":\"US\",\"emails\":[{\"value\":\"jdoe@example.com\"}],\"addresses\":[{}],\"phoneNumbers\":[{\"display\":\"5551111111\",\"primary\":false,\"type\":\"home\"},{\"display\":\"5552222222\",\"primary\":false,\"type\":\"mobile\"},{\"display\":\"5553333333\",\"primary\":false,\"type\":\"work\"}],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":1,\"customAttributes\":{}},\"agDelegation\":{\"hasDelegations\":true,\"customAttributes\":{}},\"agTerminate\":{\"terminated\":false,\"customAttributes\":{}},\"domainOCID\":\"ocid1.domain.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"userNameDb2\":\"JDOEEXAMPLECOM\",\"userNameMysql\":\"JDOEEXAMPLECOM\",\"userNameOracle\":\"JDOE@EXAMPLE.COM\",\"userNameMSSQl\":\"JDOEEXAMPLECOM\",\"agOrganizations\":[{\"value\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"displayName\":\"org-mock\",\"customAttributes\":{}}],\"targetId\":\"xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"compartmentId\":\"resource.OCI.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"domainId\":\"resource.OCI.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"region\":\"us-west-1\",\"affiliations\":{\"affiliation1\":{\"name\":\"john.doe@example.com\",\"level\":1,\"startDate\":1714456800000}},\"customAttributes\":{\"Division\":\"Mock Division\",\"CarLicense\":\"XX1234\",\"personType\":\"99\",\"ocid\":\"ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"lastSuccessfulLoginTime\":1752724311712,\"businessGroupId\":\"999\",\"cloudAccountName\":\"mockcloud\",\"saadasd\":{\"familyName\":\"Doe\",\"givenName\":\"John\"},\"timezone\":\"America/Los_Angeles\",\"DateOfJoining\":1594857600000,\"DateOfBirth\":536025600000,\"ActiveStartDate\":\"StartDate\",\"Age\":35.0,\"hnum1\":0,\"LCMCHK\":false,\"isCorrelated\":true,\"commonName\":\"John Doe\",\"BuildingNumber\":\"9999\",\"fullDN\":\"uid\\u003dJDOE@EXAMPLE.COM,ou\\u003dGROUPS,dc\\u003dmock,dc\\u003dcom\",\"compartmentOCID\":\"ocid1.tenancy.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"Company\":\"MockCorp\",\"HRAddress\":\"123 Mock St\",\"AccountDisabled\":false,\"BadgeNumber\":\"999\",\"AccountLocked\":true,\"compartmentName\":\"mockcompartment\",\"domainName\":\"Default\",\"LCMNUM\":0,\"maritalStatus\":\"S\",\"CC\":\"CC_999\",\"Tags\":\"MockTag\",\"division\":\"DivisionX\",\"myCustom_affiliation_attr\":\"TestAttr\",\"orclGuid\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"Alias\":\"alias_JDOE@EXAMPLE.COM\",\"ActiveEndDate\":\"EndDate\"},\"id\":\"globalId.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"externalId\":\"xx\",\"schemas\":[],\"meta\":{\"resourceType\":\"USER\",\"created\":1725883749126,\"lastModified\":1725883749126,\"version\":\"1\",\"location\":\"\"}}",
      "violationDetails": null
    },
    {
      "id": "globalId.ICF.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "type": "IDENTITY",
      "name": "SANDRA.SMITH@EXAMPLE.COM",
      "timeCreated": "2024-11-18T11:48:13.361Z",
      "timeUpdated": "2024-11-18T11:48:13.361Z",
      "isRuleBased": false,
      "entityType": "USER",
      "value": "{\"name\":{\"familyName\":\"Smith\",\"givenName\":\"Sandra\"},\"userName\":\"SANDRA.SMITH@EXAMPLE.COM\",\"department\":\"Finance\",\"status\":\"Disabled\",\"jobCode\":\"JC002\",\"emails\":[{}],\"addresses\":[{}],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":0,\"customAttributes\":{}},\"agDelegation\":{\"hasDelegations\":false,\"customAttributes\":{}},\"agTerminate\":{\"terminated\":false,\"customAttributes\":{}},\"userNameDb2\":\"SANDRASMITHEXAMPLECOM\",\"userNameMysql\":\"SANDRA.SMITH@EXAMPLE.COM\",\"userNameOracle\":\"SANDRA.SMITH@EXAMPLE.COM\",\"userNameMSSQl\":\"SANDRASMITHEXAMPLECOM\",\"agOrganizations\":[{\"value\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"displayName\":\"org-finance\",\"customAttributes\":{}},{\"value\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"displayName\":\"org-empty\",\"customAttributes\":{}},{\"value\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"displayName\":\"org-test\",\"customAttributes\":{}},{\"value\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"displayName\":\"org-mock\",\"customAttributes\":{}}],\"targetId\":\"xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"customAttributes\":{\"Division\":\"Finance\",\"saadasd\":{},\"ActiveStartDate\":\"StartDate\",\"Age\":42.0,\"isCorrelated\":true,\"containerDN\":\"OU\\u003dfinance,OU\\u003dcorp,DC\\u003dexample,DC\\u003dcom\",\"fullDN\":\"CN\\u003dSandraSmith,OU\\u003dfinance,OU\\u003dcorp,DC\\u003dexample,DC\\u003dcom\",\"Company\":\"MockCorp\",\"HRAddress\":\"456 Finance Blvd\",\"AccountDisabled\":true,\"BadgeNumber\":\"888\",\"AccountLocked\":true,\"Alias\":\"SANDRA.SMITH_LOC888\",\"ActiveEndDate\":\"EndDate\"},\"id\":\"globalId.ICF.xx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"externalId\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"schemas\":[],\"meta\":{\"resourceType\":\"USER\",\"created\":1731930493361,\"lastModified\":1731930493361,\"version\":\"1\",\"location\":\"\"}}",
      "violationDetails": null
    }
  ]
}