SearchPayloadQueryRequest

object
querystringrequired

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Example:type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)

Example

SearchPayloadBulkLookupRequest

object
bulk_lookupobjectrequired

Bulk lookup of entities matching the values.

Show Child Parameters
Example

SearchPayloadBulkLookup

object

Bulk lookup of entities matching the values.

typestringrequired

The entity type.

filtersarray[object]required

The values to lookup.

>= 1 items<= 1000 items

Example

SearchMode

string

The mode of search to perform. Basic search is a simple keyword search that matches the query against all searchable fields. Advanced search allows lucene-like syntax for filtering results, including logical operators and field-specific searches.

Allowed values:basicadvanced

Default:advanced

Relation

object
typestringrequired

The type of the related entity.

idstringrequired

The unique identifier of the related entity.

child_relationsarray[object]required

The child relations of the related entity.

Show Child Parameters
Example