Skip to main content

Interface: UsergroupsUsersUpdateArguments

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

Extends​

  • TokenOverridable.OptionalTeamAssignable.UsergroupsIncludeCount

Properties​

include_count?​

optional include_count: boolean;

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

Description​

Include the number of users in each User Group.

Inherited from​

UsergroupsIncludeCount.include_count

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:63

Description​

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

users​

users: string;

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

Description​

A comma separated string of encoded user IDs that represent the entire list of users for the User Group.