tridion-sites-extensions-api-docs

Home > @tridion-sites/extensions > UsersQueryProps

UsersQueryProps interface

Signature:

export interface UsersQueryProps

Properties

Property	Modifiers	Type	Description
includeDisabled?		boolean	(Optional) Specifies whether to include disabled user accounts. These are excluded by default.
predefined?		boolean	(Optional) If specified, return only non-predefined users or predefined users.
search?		string	(Optional) If specified, return only users whose account name (Title) matches this value.
searchMode?		UsersQuerySearchMode	(Optional) Specifies how to match on the account name.