Skip to main content

Interface: UsergroupsUsersListArguments

Defined in: packages/web-api/src/types/request/usergroups.ts:51

Extends​

  • TokenOverridable.OptionalTeamAssignable

Properties​

include_disabled?​

optional include_disabled: boolean;

Defined in: packages/web-api/src/types/request/usergroups.ts:55

Description​

Allow results that involve disabled User Groups.

team_id?​

optional team_id: string;

Defined in: packages/web-api/src/types/request/common.ts:70

Description​

If using an org token, team_id is required.

Inherited from​

OptionalTeamAssignable.team_id

token?​

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

usergroup​

usergroup: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:53

Description​

The encoded ID of the User Group to list users for.