Interface FindUsers

interface FindUsers {
    accountId?: string;
    maxResults?: number;
    property?: string;
    query?: string;
    startAt?: number;
    username?: string;
}

Properties

accountId? maxResults? property? query? startAt? username?

Properties

Optional accountId

accountId?: string

A query string that is matched exactly against a user accountId. Required, unless query or property is specified.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional property

property?: string

A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

Optional query

query?: string

A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified.

Optional startAt

startAt?: number

The index of the first item to return in a page of filtered results (page offset).

Optional username

username?: string

Settings

Member Visibility

Theme

On This Page

accountIdmaxResultspropertyquerystartAtusername