Jump to

• Request
• Response
• Examples

Get Entity Attributes

get

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

Retrieves a list of entity attributes used in creating 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" ]

Query Parameters

• locale: string
  Locale used for translating attribute titles.
• 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

Retrieves the Permissions Attributes.

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

Type: object

List of attributes.

Show Source

• items(required): array items
  List of attributes.

{
    "description":"List of attributes.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of attributes.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntityAttributeSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of attributes.

Show Source

• Array of: object EntityAttributeSummary
  Entity Attributes.

{
    "description":"List of attributes.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EntityAttributeSummary"
    }
}

Nested Schema : EntityAttributeSummary

Type: object

Entity Attributes.

Show Source

• defaultOrder: integer
  Default order of attribute for display.
• format: string
  Format of Attribute Type.
• id: string
  Attribute Id.
• isAdvancedFilter: boolean
  Indicated if attribute can be used in advanced filter.
• isAffiliation: boolean
  Indicated if attribute in affiliation namespace of identity.
• isCustom: boolean
  Indicated if attribute in custom namespace of identity.
• name: string
  Description of attribute.
• type: string
  Type of Attribute.

{
    "description":"Entity Attributes.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Attribute Id.",
            "type":"string"
        },
        "name":{
            "description":"Description of attribute.",
            "type":"string"
        },
        "type":{
            "description":"Type of Attribute.",
            "type":"string"
        },
        "format":{
            "description":"Format of Attribute Type.",
            "type":"string"
        },
        "defaultOrder":{
            "description":"Default order of attribute for display.",
            "type":"integer"
        },
        "isAdvancedFilter":{
            "description":"Indicated if attribute can be used in advanced filter.",
            "type":"boolean"
        },
        "isAffiliation":{
            "description":"Indicated if attribute in affiliation namespace of identity.",
            "type":"boolean"
        },
        "isCustom":{
            "description":"Indicated if attribute in custom namespace of identity.",
            "type":"boolean"
        }
    }
}

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

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 entity attributes containing the metadata fields useful for creating an Ownership Campaign.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns/attributes/ORCHESTRATED_SYSTEMS'

Example of the Response Body

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

{
    "items": [
        {
            "id": "customAttributes.createBy",
            "name": "Created by",
            "type": "string",
            "format": null,
            "defaultOrder": -1,
            "isAdvancedFilter": false,
            "isAffiliation": false,
            "isCustom": true
        },
        {
            "id": "meta.created",
            "name": "Created date",
            "type": "string",
            "format": "date-time",
            "defaultOrder": 3,
            "isAdvancedFilter": true,
            "isAffiliation": false,
            "isCustom": false
        },
        {
            "id": "meta.lastModified",
            "name": "Last updated",
            "type": "string",
            "format": "date-time",
            "defaultOrder": 4,
            "isAdvancedFilter": true,
            "isAffiliation": false,
            "isCustom": false
        },
        {
            "id": "targetName",
            "name": "Name",
            "type": "string",
            "format": null,
            "defaultOrder": 1,
            "isAdvancedFilter": true,
            "isAffiliation": false,
            "isCustom": false
        },
        {
            "id": "owner.displayName",
            "name": "Primary owner name",
            "type": "string",
            "format": null,
            "defaultOrder": 2,
            "isAdvancedFilter": true,
            "isAffiliation": false,
            "isCustom": false
        }
    ]
}

Back to Top