Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface SearchUser

    interface SearchUser {
        cql: string;
        expand?: string[];
        limit?: number;
        start?: number;
    }
    Index

    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 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”
    
    expand?: string[]

    A multi-value parameter indicating which properties of the user to expand.

    • operations returns the operations for the user, which are used when setting permissions.
    • personalSpace returns the personal space of the user.
    limit?: number

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

    start?: number

    The starting index of the returned users.