interface UserSearch {
    cql: string;
    limit?: number;
    start?: number;
}

Properties

Properties

cql: string

The CQL query to be used for the search. See Advanced Searching using CQL for instructions on how to build a CQL query.

Example

Example queries:

cql=type=user // will return all users
cql=user="1234" // will return user with accountId “1234”

// You can also use IN, NOT IN, != operators

cql=user IN ("12", "34") // will return users with accountids “12” and “34”
cql=user.fullname~jo // will return users with nickname/full name starting with “jo”
cql=user.accountid="123" // will return user with accountId “123”
limit?: number

The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.

Default

25

Minimum

0

start?: number

The starting index of the returned users.

Default

0

Minimum

0

Generated using TypeDoc v0.25.12