Interface: AdminUsersInviteArguments
Extends
ChannelIDs.TeamID.IsRestricted.IsUltraRestricted.TokenOverridable
Properties
channel_ids
channel_ids: [string, ...string[]];
Description
An array of channel IDs (must include at least one ID).
Inherited from
ChannelIDs.channel_ids
Defined in
packages/web-api/src/types/request/common.ts:81
custom_message?
optional custom_message: string;
Description
An optional message to send to the user in the invite email.
Defined in
packages/web-api/src/types/request/admin/users.ts:72
email
email: string;
Description
The email address of the person to invite.
Defined in
packages/web-api/src/types/request/admin/users.ts:70
email_password_policy_enabled?
optional email_password_policy_enabled: boolean;
Description
Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.
Defined in
packages/web-api/src/types/request/admin/users.ts:77
guest_expiration_ts?
optional guest_expiration_ts: string;
Description
Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.
Defined in
packages/web-api/src/types/request/admin/users.ts:82
is_restricted?
optional is_restricted: boolean;
Description
Set to true if user should be added to the workspace as a guest.
Inherited from
IsRestricted.is_restricted
Defined in
packages/web-api/src/types/request/admin/users.ts:15
is_ultra_restricted?
optional is_ultra_restricted: boolean;
Description
Set to true if user should be added to the workspace as a guest.
Inherited from
IsUltraRestricted.is_ultra_restricted
Defined in
packages/web-api/src/types/request/admin/users.ts:20
real_name?
optional real_name: string;
Description
Full name of the user.
Defined in
packages/web-api/src/types/request/admin/users.ts:84
resend?
optional resend: boolean;
Description
Allow this invite to be resent in the future if a user has not signed up yet.
Resending can only be done via the UI and has no expiration. Defaults to false.
Defined in
packages/web-api/src/types/request/admin/users.ts:89
team_id
team_id: string;
Description
The encoded team ID.
Inherited from
TeamID.team_id
Defined in
packages/web-api/src/types/request/common.ts:61
token?
optional token: string;
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token