Struct CreateInvitationRequest 

pub struct CreateInvitationRequest {
    pub email_address: String,
    pub public_metadata: Option<Value>,
    pub redirect_url: Option<String>,
    pub notify: Option<Option<bool>>,
    pub ignore_existing: Option<Option<bool>>,
}

Fields

email_address: String

The email address the invitation will be sent to

public_metadata: Option<Value>

Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user’s public metadata.

redirect_url: Option<String>

Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you’re not using Clerk Hosted Pages or Clerk Components.

notify: Option<Option<bool>>

Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true.

ignore_existing: Option<Option<bool>>

Whether an invitation should be created if there is already an existing invitation for this email address, or it’s claimed by another user.

Implementations

impl CreateInvitationRequest

pub fn new(email_address: String) -> CreateInvitationRequest

Trait Implementations

impl Clone for CreateInvitationRequest

fn clone(&self) -> CreateInvitationRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateInvitationRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateInvitationRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateInvitationRequest

fn eq(&self, other: &CreateInvitationRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateInvitationRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateInvitationRequest