query()

Home > @gooddata/sdk-backend-spi > IWorkspaceUserGroupsQuery > query

IWorkspaceUserGroupsQuery.query() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Starts the user groups query.

Signature:

query(options: IWorkspaceUserGroupsQueryOptions): Promise<IWorkspaceUserGroupsQueryResult>;

Parameters

ParameterTypeDescription
optionsIWorkspaceUserGroupsQueryOptions

Returns:

Promise<IWorkspaceUserGroupsQueryResult>

promise with a list of all user groups matching the specified options