Skip to content

AdminUsersInviteArguments.md

Latest commit

 

History

History
196 lines (116 loc) · 4.05 KB

AdminUsersInviteArguments.md

File metadata and controls

196 lines (116 loc) · 4.05 KB

@slack/web-api / AdminUsersInviteArguments

Interface: AdminUsersInviteArguments

Defined in: src/types/request/admin/users.ts:63

Extends

  • ChannelIDs.TeamID.IsRestricted.IsUltraRestricted.TokenOverridable

Properties

channel_ids

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

Defined in: src/types/request/common.ts:81

Description

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

Inherited from

ChannelIDs.channel_ids

custom_message?

optional custom_message: string;

Defined in: src/types/request/admin/users.ts:72

Description

An optional message to send to the user in the invite email.

email

email: string;

Defined in: src/types/request/admin/users.ts:70

Description

The email address of the person to invite.

email_password_policy_enabled?

optional email_password_policy_enabled: boolean;

Defined in: src/types/request/admin/users.ts:77

Description

Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.

guest_expiration_ts?

optional guest_expiration_ts: string;

Defined in: src/types/request/admin/users.ts:82

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.

is_restricted?

optional is_restricted: boolean;

Defined in: 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: 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

real_name?

optional real_name: string;

Defined in: src/types/request/admin/users.ts:84

Description

Full name of the user.

resend?

optional resend: boolean;

Defined in: src/types/request/admin/users.ts:89

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.

team_id

team_id: string;

Defined in: src/types/request/common.ts:61

Description

The encoded team ID.

Inherited from

TeamID.team_id

token?

optional token: string;

Defined in: src/types/request/common.ts:43

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token