tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ListsService > getUsers

ListsService.getUsers() method

Gets a list of Users. This operation returns an instance of ‘User’ type or one of the following inherited types:<ul class="model-list"><li>AccessToken</li></ul>

Signature:

static getUsers({ predefined, includeDisabled, search, searchMode, }: {
        predefined?: boolean;
        includeDisabled?: boolean;
        search?: string;
        searchMode?: 'Contains' | 'StartsWith' | 'EndsWith' | 'ExactMatch';
    }): CancelablePromise<Array<User>>;

Parameters

Parameter	Type	Description
{ predefined, includeDisabled, search, searchMode, }	{ predefined?: boolean; includeDisabled?: boolean; search?: string; searchMode?: ‘Contains’ | ‘StartsWith’ | ‘EndsWith’ | ‘ExactMatch’; }

Returns:

CancelablePromise<Array<User>>

User The request was successful.

Exceptions

ApiError