Skip to main content

PublicIdentitiesSearchRequest

Properties​

NameTypeDescriptionNotes
QueryTypeEnum [ "COMPOSITE" ]Search query type. Must be COMPOSITE.[required]
Indices[]StringSearch indices. Must be exactly [""identities""].[required]
IncludeNestedBooleanMust be false for public identities search.[required]
Sort[]StringOptional attribute keys to sort by. Base keys must match those returned by GET /public-identities/v2/visible-attributes (defaultAttributes + configuredAttributes). Optional ""attributes."" prefix and/or "".exact"" suffix.[optional]
QuerySetPublicIdentitiesSearchRequestQuerySet[required]

Examples​

  • Prepare the resource
$PublicIdentitiesSearchRequest = Initialize-PublicIdentitiesSearchRequest -QueryType COMPOSITE `
-Indices ["identities"] `
-IncludeNested false `
-Sort ["name"] `
-QuerySet null
  • Convert the resource to JSON
$PublicIdentitiesSearchRequest | ConvertTo-JSON

[Back to top]