Skip to main content

Interface: UsergroupsUsersUpdateArguments

Extends

  • TokenOverridable.OptionalTeamAssignable.UsergroupsIncludeCount

Properties

include_count?

optional include_count: boolean;

Description

Include the number of users in each User Group.

Inherited from

UsergroupsIncludeCount.include_count

Defined in

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


team_id?

optional team_id: string;

Description

If using an org token, team_id is required.

Inherited from

OptionalTeamAssignable.team_id

Defined in

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


token?

optional token: string;

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

Defined in

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


usergroup

usergroup: string;

Description

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

Defined in

packages/web-api/src/types/request/usergroups.ts:63


users

users: string;

Description

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

Defined in

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