Jump to

• Request
• Response
• Examples

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

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.

Back to Top

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.

Body ()

Root Schema : AccessGovernanceTypeCollection

Type: object

A list of Access Governance Entity items.

Show Source

• items(required): array items
  List of Access Governance Entity items.

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

Nested Schema : items

Type: array

List of Access Governance Entity items.

Show Source

• Array of: object AccessGovernanceEntity
  An Access Governance Entity

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

Nested Schema : AccessGovernanceEntity

Type: object

An Access Governance Entity

Show Source

• entityType(required): string
  The Entity type in Access Governance
• id(required): string
  The Id for Access Governance Entity
• isRuleBased: boolean
  Is this identity ruled based
• name(required): string
  The name for Access Governance Type
• timeCreated(required): string(date-time)
  Time when entity was created by Access Governance
• timeUpdated(required): string(date-time)
  Time when entity was last modified by Access Governance
• 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
• value(required): string
  The json schema for Access Governance Type
• violationDetails(required): object ViolationDetails
  The Violation details object

{
    "type":"object",
    "required":[
        "entityType",
        "id",
        "name",
        "timeCreated",
        "timeUpdated",
        "type",
        "value",
        "violationDetails"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for 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 Access Governance Type"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was created by Access Governance"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was last modified by Access Governance"
        },
        "isRuleBased":{
            "type":"boolean",
            "description":"Is this identity ruled based"
        },
        "entityType":{
            "type":"string",
            "description":"The Entity type in Access Governance"
        },
        "value":{
            "type":"string",
            "description":"The json schema for Access Governance Type"
        },
        "violationDetails":{
            "$ref":"#/definitions/ViolationDetails"
        }
    },
    "description":"An Access Governance Entity"
}

Nested Schema : ViolationDetails

Type: object

The Violation details object

Show Source

• accessGuardrailViolationId(required): string
  The access guardrail violation id
• violationType(required): string
  Allowed Values: [ "NO_VIOLATION", "LOW_RISK_ACCESS_GUARDRAIL_VIOLATION", "HIGH_RISK_ACCESS_GUARDRAIL_VIOLATION", "VIOLATION_NOT_AVAILABLE" ]

  The Violation type in Access Governance

{
    "type":"object",
    "required":[
        "accessGuardrailViolationId",
        "violationType"
    ],
    "properties":{
        "violationType":{
            "type":"string",
            "description":"The Violation type in Access Governance",
            "enum":[
                "NO_VIOLATION",
                "LOW_RISK_ACCESS_GUARDRAIL_VIOLATION",
                "HIGH_RISK_ACCESS_GUARDRAIL_VIOLATION",
                "VIOLATION_NOT_AVAILABLE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ViolationType"
        },
        "accessGuardrailViolationId":{
            "type":"string",
            "description":"The access guardrail violation id"
        }
    },
    "description":"The Violation details 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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

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": "[e-mail]",
      "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\":\"[e-mail]\",\"displayName\":\"John Doe\",\"description\":\"Sample description\",\"primaryEmail\":\"[e-mail]\",\"userType\":\"Contractor\",\"organization\":{\"value\":\"organization.xx.xx.xx.xx.xx\",\"displayName\":\"Engineering\"},\"status\":\"Active\",\"jobCode\":\"JC001\",\"state\":\"CA\",\"risk\":5,\"location\":\"US\",\"emails\":[{\"value\":\"[e-mail]\"}],\"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\":\"[e-mail]\",\"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\":\"[e-mail]\",\"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\\[e-mail],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\":\"[e-mail]\",\"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": "[e-mail]",
      "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\":\"[e-mail]\",\"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\":\"[e-mail]\",\"userNameOracle\":\"[e-mail]\",\"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
    }
  ]
}

Back to Top