# Search for roles.

Endpoint: POST /roles/search
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies descending order.

## Request body:

  - `application/json` (unknown)
    A request body containing a filter expression. This enables searching
for items matching arbitrarily complex conditions. The list of
attributes which can be used in filter expressions is available
in the x-filterable vendor extension.
# Filter Expression Overview
**Note: All keywords are case-insensitive**
## Comparison Operators
| Operator | Description | Example |
|  --- | --- | --- |
| CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE |
| IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] |
| GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |
| GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |
| LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |
| LT | Tests if a field is less than a literal value | field1 LT 9.02 |
| NE | Tests if a field is not equal to a literal value | field1 NE 42 |
| EQ | Tests if a field is equal to a literal value | field1 EQ 42 |

## Search Operator
The SEARCH operator filters for items which have any filterable
attribute that contains the input string as a substring, comparison
is done case-insensitively. This is not restricted to attributes with
string values. Specifically `SEARCH '12'` would match an item with an
attribute with an integer value of `123`.
## Logical Operators
Ordered by precedence.
| Operator | Description | Example |
|  --- | --- | --- |
| NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |
| AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' |
| OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' |

## Grouping
Parenthesis `()` can be used to override operator precedence.
For example:
NOT (field1 LT 1234 AND field2 CONTAINS 'foo')
## Literal Values
| Literal | Description | Examples |
|  --- | --- | --- |
| Nil | Represents the absence of a value | nil, Nil, nIl, NIL |
| Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |
| Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |
| String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' |
| Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |
| List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] |

## Limitations
- A maximum of 8 unique identifiers may be used inside a filter expression.

## Request fields (application/json):

  - `filter_expression` (string)
    Example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"

## Request examples:

  - `Nested Object Comparison` (unknown)
    An example of a nested Object comparison testing that at least one repository has a
version which is equal to 19.0.0.

  - `Relative comparison` (unknown)
    An example of a relative comparison testing that field1 has a
value which is less than 123.

  - `Absence of an attribute value` (unknown)
    An example of using nil to test for the absence of a value for field2.

  - `Existence of an attribute value` (unknown)
    An example of using nil to test for the existence of a value for field2.

  - `Use of the CONTAINS operator` (unknown)
    An example of using the 'CONTAINS' operator to check if
field2 contains the string 'foo'. If field2 is string valued
then this is checking if 'foo' is a substring of field2. If
field2 is a list of strings then this is checking if 'foo'
is a member of the list.

  - `Use of the IN operator` (unknown)
    An example of using the 'IN' operator to check if field1
is an element of a list literal.

  - `Use of the SEARCH operator` (unknown)
    An example of using the 'SEARCH' operator to retrieve all elements
for which 'foo' is a substring of a filterable attribute.

  - `Overriding operator precedence` (unknown)
    An example of parenthesis being used to group operators & override
operator precedence.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.name` (string, required)
    The Role name.

  - `items.description` (string)
    Role description.

  - `items.permission_objects` (array, required)
    The list of permissions granted by this role.

  - `items.permission_objects.object_type` (string, required)
    Object type.
    Enum: "ALGORITHM", "ACCESS_GROUP", "ACCOUNT", "AUDIT_LOGS_SUMMARY_REPORT", "ROLE", "API_USAGE_REPORT", "BOOKMARK", "CDB", "CLASSIFIER", "DATA_CLASS", "DATABASE_TEMPLATE", "DISCOVERY_EXPRESSION", "DISCOVERY_POLICY", "DSOURCE", "ENGINE", "ENVIRONMENT", "COMPLIANCE_JOB_COLLECTION", "MASKING_JOB", "MASKING_ENVIRONMENT", "MASKING_FILE_UPLOAD", "MASKING_JOB_SET", "REPORT_SCHEDULE", "RULE_SET", "SOURCE", "VAULT", "VCDB", "VDB", "VDB_GROUP", "CONNECTOR", "CONNECTIVITY_CHECK", "DSOURCE_USAGE_REPORT", "DSOURCE_CONSUMPTION_REPORT", "JOB", "DCT_PRODUCT_TELEMETRY_BUNDLE", "PRODUCT_INFO", "PRODUCT_REGISTRATION", "PROXY_CONFIGURATION", "SMTP_CONFIG", "MASKING_EXECUTION_METRICS_REPORT", "STORAGE_SUMMARY_REPORT", "STORAGE_SAVINGS_SUMMARY_REPORT", "VDB_INVENTORY_REPORT", "LDAP", "SAML", "PASSWORD_POLICY", "GLOBAL_PROPERTIES", "SYSTEM", "API_CLASSIFICATION", "VIRTUALIZATION_POLICY", "DATASET_GROUP", "METADATA_DATABASE", "ENGINE_VAULT", "KERBEROS_CONFIG", "TIMEFLOW", "HYPERSCALE_INSTANCE", "HYPERSCALE_CONNECTOR", "HYPERSCALE_DATASET", "TOOLKIT", "MASKING_PLUGIN", "REPLICATION_PROFILE", "NAMESPACE", "ENGINE_PERFORMANCE_ANALYTIC_REPORT", "STAGING_SOURCE", "DATA_RISK_REPORT", "ENGINE_GLOBAL_OBJECT_STATE_REPORT", "DATA_LAYOUT", "VIRTUALIZATION_JOB", "GLOBAL_TAG", "VIRTUALIZATION_ACTION", "VIRTUALIZATION_ALERT", "VIRTUALIZATION_FAULT", "LICENSE", "VIRTUALIZATION_POLICY_TARGET", "UPGRADE_MIGRATE_JOB", "DATA_CONNECTION", "HOOK_TEMPLATE", "JOB_ORCHESTRATOR", "AI_SERVICE", "STAGING_CDB", "LICENSE_USAGE_SUMMARY_REPORT", "SYNTHETIC_APPLICATION", "SYNTHETIC_DATASET", "SYNTHETIC_CONNECTOR", "SYNTHETIC_GENERATOR_FRAMEWORK", "SYNTHETIC_JOB", "SYNTHETIC_FILE", "SYNTHETIC_EXECUTION", "SYNTHETIC_EXECUTION_COMPONENT", "SYNTHETIC_SEED_LIST_FILE", "SYNTHETIC_GENERATOR_INSTANCE", "PAAS_PLUGIN", "CLOUD_ACCOUNT", "PAAS_DATABASE", "CDB_DSOURCE", "PAAS_INSTANCE", "SYNTHETIC_JDBC_DRIVER", "MOUNT_INFORMATION", "RECORD_TYPE", "LLM_PROVIDER", "COMPLIANCE_JDBC_DRIVER", "SSH_KEY", "UPGRADE_IMAGE", "UPGRADE_OPERATION", "COMPLIANCE_PASSWORD_VAULT", "COMPLIANCE_CREDENTIAL_PATH", "FILE_FORMAT", "MAINFRAME_DATASET_FORMAT", "FILE_FIELD", "FEATURE_ASSIGNMENT", "STANDALONE_SERVICE", "SYNTHETIC_JDBC_PARAMETER_EXEMPTION"

  - `items.permission_objects.permissions` (array, required)
    List of permissions.

  - `items.immutable` (boolean)
    If set to true, adding or removing permission is not allowed.

  - `items.tags` (array)

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.ui_profiles` (array)
    The list of profiles that influence the navigation menus shown in the UI.

  - `items.id` (string)
    The Role ID.

  - `items.system_role` (boolean)
    System role are pre defined roles. System roles cannot be modified.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.