Skip to main content

Interface: AdminUsergroupsAddTeamsArguments

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

Extends

  • UsergroupID.TokenOverridable

Properties

auto_provision?

optional auto_provision: boolean;

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

Description

When true, this method automatically creates new workspace accounts for the IDP group members. Defaults to false.


team_ids

team_ids: string | string[];

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

Description

One or more encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.


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_id

usergroup_id: string;

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

Description

ID of the IDP group to list/manage channels for.

Inherited from

UsergroupID.usergroup_id