slackline/api/admin/users/invite

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of admin.users.invite. Each setter takes the call that users.invite returns and sets one argument:

users.invite(team_id: "team_id", email: "joe@email.com", channel_ids: channel_ids)
|> invite.custom_message("Come and join our team!")

Values

pub fn custom_message(
  call: slackline.Call(users.Invite, r),
  custom_message: String,
) -> slackline.Call(users.Invite, r)

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

pub fn email_password_policy_enabled(
  call: slackline.Call(users.Invite, r),
  email_password_policy_enabled: Bool,
) -> slackline.Call(users.Invite, r)

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

pub fn guest_expiration_ts(
  call: slackline.Call(users.Invite, r),
  guest_expiration_ts: String,
) -> slackline.Call(users.Invite, r)

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.

pub fn is_restricted(
  call: slackline.Call(users.Invite, r),
  is_restricted: Bool,
) -> slackline.Call(users.Invite, r)

Is this user a multi-channel guest user? (default: false)

pub fn is_ultra_restricted(
  call: slackline.Call(users.Invite, r),
  is_ultra_restricted: Bool,
) -> slackline.Call(users.Invite, r)

Is this user a single channel guest user? (default: false)

pub fn real_name(
  call: slackline.Call(users.Invite, r),
  real_name: String,
) -> slackline.Call(users.Invite, r)

Full name of the user.

pub fn resend(
  call: slackline.Call(users.Invite, r),
  resend: Bool,
) -> slackline.Call(users.Invite, r)

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. (default: false)

✨ Search Document