Struct SignUpOpts 

pub struct SignUpOpts {
    pub identify_by: IdenticationRequirement,
    pub allow_sign_up: bool,
    pub auto_assign_tags: Vec<AccessTag>,
    pub allowed_authn: Vec<GeneralAuthenticationRequirement>,
    pub required_authn: Vec<GeneralAuthenticationRequirement>,
}

Sign up options.

Fields

identify_by: IdenticationRequirement

Identication requirement.

Email by default.

allow_sign_up: bool

You can temporarily disable user registration.

Enabled by default.

auto_assign_tags: Vec<AccessTag>

Assign given tags on common user registration.

allowed_authn: Vec<GeneralAuthenticationRequirement>

Users can choose any requirements from this list to construct their own authentication flow. But you can also strict their flows as application backend developers by frontend limiting.

required_authn: Vec<GeneralAuthenticationRequirement>

These requirements are mandatory to choose in every single authentication flow.

Implementations

impl SignUpOpts

pub fn new() -> Self

Creates new options.

pub fn with_id_type(self, id_type: IdenticationRequirement) -> Self

Specifies identification requirement.

pub fn with_signup_enabled(self, enabled: bool) -> Self

Enables or disables new users’ registration.

pub fn with_auto_tags(self, tags: &[impl Into<AccessTag> + Clone]) -> Self

Specifies auto-assign tags.

pub fn with_allowed_steps( self, steps: &[GeneralAuthenticationRequirement], ) -> Self

Specifies allowed authentication steps.

pub fn with_required_steps( self, steps: &[GeneralAuthenticationRequirement], ) -> Self

Specifies required authentication steps.

Trait Implementations

impl Clone for SignUpOpts

fn clone(&self) -> SignUpOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignUpOpts

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

Formats the value using the given formatter.

impl Default for SignUpOpts

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignUpOpts

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SignUpOpts

impl PartialEq for SignUpOpts

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

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 SignUpOpts

impl ToSchema for SignUpOpts

fn to_schema(components: &mut Components) -> RefOr<Schema>

Returns a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.