Jump to

• Request
• Response
• Examples

List attribute values for the given entity type

get

/access-governance/access-reviews/20250331/campaigns/attributes/{agEntityType}/{attributeId}/values

Returns attribute values for a specific entity type. Applicable for an Ownership Campaign.

Request

Path Parameters

• agEntityType(required): string
  The type of entity to retrieve attributes for.

  Allowed Values: [ "ACCESS_BUNDLES", "ACCESS_GUARDRAILS", "APPROVAL_WORKFLOWS", "IDENTITY_COLLECTIONS", "ORCHESTRATED_SYSTEMS", "POLICIES", "ROLES" ]
• attributeId(required): string
  ID of the Entity Attribute Id to retrieve the attribute values/info.

Query Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of permission attributes values 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 : EntityAttributeValueCollection

Type: object

A list of Entity Attribute Value item.

Show Source

• items(required): array items
  List of Entity AttributeValue items.

{
    "type":"object",
    "description":"A list of Entity Attribute Value item.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of Entity  AttributeValue items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntityAttributeValue"
            }
        }
    }
}

Nested Schema : items

Type: array

List of Entity AttributeValue items.

Show Source

• Array of: object EntityAttributeValue
  The EntityAttributeValue.

{
    "description":"List of Entity  AttributeValue items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EntityAttributeValue"
    }
}

Nested Schema : EntityAttributeValue

Type: object

The EntityAttributeValue.

Show Source

• name(required): string
  The name for Access Governance Type.
• value(required): string
  The json schema for Access Governance Type.

{
    "type":"object",
    "description":"The EntityAttributeValue.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name for Access Governance Type."
        },
        "value":{
            "type":"string",
            "description":"The json schema for Access Governance Type."
        }
    }
}

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 details for a specific identity.

cURL Example - Without Query Parameters

Run the following before running this API

• Get a list of Entity Attributes campaigns/attributes/${agEntityType}

Use the id from response as the attributeId.

For this example, use the following values

• ${agEntityType}: ORCHESTRATED_SYSTEMS
• ${attributeId}: targetName

curl -i -X GET \
 -H "Authorization:Bearer <your access token >" \
 '${service-instance-url}/access-governance/access-reviews/${versionId}/campaigns/attributes/${agEntityType}/${attributeId}/values'

Example of the Response Body

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

{
  "items": [
    {
      "name": "targetName",
      "value": "AD_Group_01"
    },
    {
      "name": "targetName",
      "value": "DBAT_MySQL_Cluster"
    },
    {
      "name": "targetName",
      "value": "HRMS_EBS_Connector_UA"
    },
    {
      "name": "targetName",
      "value": "FlatFile_HR_Org"
    }
  ]
}

Back to Top