tridion-sites-extensions-api-docs

Home > @tridion-sites/extensions > UserGroupsQueryProps

UserGroupsQueryProps interface

Signature:

export interface UserGroupsQueryProps

Properties

Property Modifiers Type Description
includeEveryone?   boolean (Optional) Specifies whether the special “Everyone” Group (representing all CM users) should be returned.
inPublicationId?   ItemUri (Optional) If specified, return only groups which are scoped to the Publication ID.
search?   string (Optional) If specified, return only groups with titles matching this value.
searchMode?   UserGroupsQuerySearchMode (Optional) Specifies how to match on the group title.