Skip to main content

Interface: AdminUsersAssignArguments

Defined in: packages/web-api/src/types/request/admin/users.ts:54

Extends​

  • TeamID.UserID.Partial<ChannelIDs>.IsRestricted.IsUltraRestricted.TokenOverridable

Properties​

channel_ids?​

optional channel_ids: [string, ...string[]];

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

Description​

An array of channel IDs (must include at least one ID).

Inherited from​

Partial.channel_ids

is_restricted?​

optional is_restricted: boolean;

Defined in: packages/web-api/src/types/request/admin/users.ts:15

Description​

Set to true if user should be added to the workspace as a guest.

Inherited from​

IsRestricted.is_restricted

is_ultra_restricted?​

optional is_ultra_restricted: boolean;

Defined in: packages/web-api/src/types/request/admin/users.ts:20

Description​

Set to true if user should be added to the workspace as a guest.

Inherited from​

IsUltraRestricted.is_ultra_restricted

team_id​

team_id: string;

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

Description​

The encoded team ID.

Inherited from​

TeamID.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

user_id​

user_id: string;

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

Description​

Encoded user ID.

Inherited from​

UserID.user_id