Jump to

• Request
• Response
• Examples

Get Identity Operators

get

/access-governance/identities/20250331/identities/operators

Gets Identity Operators.

Request

Query Parameters

• attributeType: string
  Attribute Type Query Param

  Default Value: All
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 10
• name: string
  Maximum Length: 100

  A name to filter results
• 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

Retrieves the Identity 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 : IdentityOperatorCollection

Type: object

List of Identity Operators.

Show Source

• items(required): array items
  List of Identity Operators.

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

Nested Schema : items

Type: array

List of Identity Operators.

Show Source

• Array of: object IdentityOperatorSummary
  Identity Operators.

{
    "type":"array",
    "description":"List of Identity Operators.",
    "items":{
        "$ref":"#/definitions/IdentityOperatorSummary"
    }
}

Nested Schema : IdentityOperatorSummary

Type: object

Identity Operators.

Show Source

• id: string
  Numeric Id.
• name: string
  Description of operator.
• operatorSyntax: string
  Syntax of operator.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Numeric Id."
        },
        "name":{
            "type":"string",
            "description":"Description of operator."
        },
        "operatorSyntax":{
            "type":"string",
            "description":"Syntax of operator."
        }
    },
    "description":"Identity Operators."
}

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

cURL Example - Without Query Parameters

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

cURL Example - With Query Parameters

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

Example of the Response Body

The following example shows the operators with attribute type = integer in JSON format:

{
  "items" : [ {
    "id" : "EQ",
    "name" : "Equals",
    "operatorSyntax" : "EQ"
  }, {
    "id" : "NE",
    "name" : "Not equals",
    "operatorSyntax" : "NE"
  }, {
    "id" : "GT",
    "name" : "Greater than",
    "operatorSyntax" : "GT"
  }, {
    "id" : "LT",
    "name" : "Less than",
    "operatorSyntax" : "LT"
  }, {
    "id" : "GE",
    "name" : "Greater than or equal to",
    "operatorSyntax" : "GE"
  }, {
    "id" : "LE",
    "name" : "Less than or equal to",
    "operatorSyntax" : "LE"
  }, {
    "id" : "IN",
    "name" : "In",
    "operatorSyntax" : "IN"
  }, {
    "id" : "NOT_IN",
    "name" : "Not in",
    "operatorSyntax" : "NOT IN"
  }, {
    "id" : "BETWEEN",
    "name" : "Between",
    "operatorSyntax" : "BETWEEN"
  }, {
    "id" : "NOT_BETWEEN",
    "name" : "Not between",
    "operatorSyntax" : "NOT BETWEEN"
  } ]
}

Back to Top