Struct MemberAddArg

#[non_exhaustive]
pub struct MemberAddArg {
    pub member_email: EmailAddress,
    pub member_given_name: Option<OptionalNamePart>,
    pub member_surname: Option<OptionalNamePart>,
    pub member_external_id: Option<MemberExternalId>,
    pub member_persistent_id: Option<String>,
    pub send_welcome_email: bool,
    pub is_directory_restricted: Option<bool>,
    pub role: AdminTier,
}

Available on crate features sync_routes and dbx_team only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

member_email: EmailAddress

member_given_name: Option<OptionalNamePart>

Member’s first name.

member_surname: Option<OptionalNamePart>

Member’s last name.

member_external_id: Option<MemberExternalId>

External ID for member.

member_persistent_id: Option<String>

Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.

send_welcome_email: bool

Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.

is_directory_restricted: Option<bool>

Whether a user is directory restricted.

role: AdminTier

Implementations

impl MemberAddArg

pub fn new(member_email: EmailAddress) -> Self

pub fn with_member_given_name(self, value: OptionalNamePart) -> Self

pub fn with_member_surname(self, value: OptionalNamePart) -> Self

pub fn with_member_external_id(self, value: MemberExternalId) -> Self

pub fn with_member_persistent_id(self, value: String) -> Self

pub fn with_send_welcome_email(self, value: bool) -> Self

pub fn with_is_directory_restricted(self, value: bool) -> Self

pub fn with_role(self, value: AdminTier) -> Self

Trait Implementations

impl Clone for MemberAddArg

fn clone(&self) -> MemberAddArg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemberAddArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MemberAddArg

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<MemberAddArg> for MemberAddArgBase

fn from(subtype: MemberAddArg) -> Self

Converts to this type from the input type.

impl PartialEq for MemberAddArg

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for MemberAddArg

impl StructuralPartialEq for MemberAddArg