PrincipalFilter

Principal Filter

A list of conditional criteria used to refine and narrow down the search results. Multiple filters are applied using logical 'AND' conditions (i.e., a record must satisfy all provided filters to be returned).

JSON Example

{
    "key": "ROLE_NAME",
    "operator": "IN",
    "value": [
        "Tenant Admin",
        "License Manager"
    ]
}

string

key

Required

Filter object for search principal API. ROLES key is deprecated, use ROLE_NAME instead. Below is list of keys allowed

• TYPE - allowed type is OAUTH_CLIENT.Search Request for Oauth Apps must have this filter included.
• CLIENT_TYPE - Oauth App client type allowed values are GENERAL
• ID - Oauth App client ID
• NAME - Oauth App Name
• DESCRIPTION - description of Oauth App
• UPDATED_BY - updated by user
• FREE_TEXT - Any text which will be searched in Oauth App Name, Oauth App Description, Assigned Role Name to Oauth App. Only LIKE operation is supported for this key.
• ROLE_NAME - role name of role, all Oauth Apps with this role will be searched

Possible values are : TYPE, CLIENT_TYPE, ID, NAME, ROLES, DESCRIPTION, UPDATED_BY, FREE_TEXT, ROLE_NAME,

string

operator

Required

Indicates the type of Operators

• LIKE - Oauth App attribute mentioned in Filter's KEY will be searched to find given value
• EQUALS - Oauth App attribute mentioned in Filter's KEY will be exactly matched to given value in filter
• IN - Oauth App attribute mentioned in Filter's KEY will be exactly matched to one of values in given value list in filter

Possible values are : LIKE, EQUALS, IN,

string

value

Required

Actual value which needs to be searched.

• LIKE and EQUALS operator single string value is expected
• IN operator one or more values are expected. Example: ["VALUE1", "VALUE2"]

Property Of

PrincipalSearchRequest