Struct CreateOrganizationInvitationRequest 

pub struct CreateOrganizationInvitationRequest {
    pub email_address: String,
    pub inviter_user_id: String,
    pub role: String,
    pub public_metadata: Option<Value>,
    pub private_metadata: Option<Value>,
    pub redirect_url: Option<String>,
}

Fields

email_address: String

The email address of the new member that is going to be invited to the organization

inviter_user_id: String

The ID of the user that invites the new member to the organization. Must be an administrator in the organization.

role: String

The role of the new member in the organization

public_metadata: Option<Value>

Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.

private_metadata: Option<Value>

Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.

redirect_url: Option<String>

Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.

Implementations

impl CreateOrganizationInvitationRequest

pub fn new( email_address: String, inviter_user_id: String, role: String, ) -> CreateOrganizationInvitationRequest

Trait Implementations

impl Clone for CreateOrganizationInvitationRequest

fn clone(&self) -> CreateOrganizationInvitationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOrganizationInvitationRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateOrganizationInvitationRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateOrganizationInvitationRequest

fn eq(&self, other: &CreateOrganizationInvitationRequest) -> 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 CreateOrganizationInvitationRequest

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 CreateOrganizationInvitationRequest