Skip to main content

Tenant

firebase_admin_sdk::auth::tenant_mgt

Struct Tenant

pub struct Tenant {Show 14 fields
    pub name: String,
    pub display_name: Option<String>,
    pub allow_password_signup: Option<bool>,
    pub enable_email_link_signin: Option<bool>,
    pub disable_auth: Option<bool>,
    pub enable_anonymous_user: Option<bool>,
    pub test_phone_numbers: Option<HashMap<String, String>>,
    pub mfa_config: Option<Value>,
    pub recaptcha_config: Option<Value>,
    pub sms_region_config: Option<Value>,
    pub monitoring: Option<Value>,
    pub password_policy_config: Option<Value>,
    pub email_privacy_config: Option<Value>,
    pub client: Option<Value>,
}

Expand description

Represents a tenant in a multi-tenant project.

Fields§

§name: String

The resource name of the tenant. Format: “projects/{project-id}/tenants/{tenant-id}”

§display_name: Option<String>

The display name of the tenant.

§allow_password_signup: Option<bool>

Whether to allow email/password user authentication.

§enable_email_link_signin: Option<bool>

Whether to enable email link user authentication.

§disable_auth: Option<bool>

Whether authentication is disabled for the tenant.

§enable_anonymous_user: Option<bool>

Whether to enable anonymous user authentication.

§test_phone_numbers: Option<HashMap<String, String>>

Map of test phone numbers and their fake verification codes.

§mfa_config: Option<Value>

The tenant-level configuration of MFA options.

§recaptcha_config: Option<Value>

The tenant-level reCAPTCHA config.

§sms_region_config: Option<Value>

Configures which regions are enabled for SMS verification.

§monitoring: Option<Value>

Configuration related to monitoring project activity.

§password_policy_config: Option<Value>

The tenant-level password policy config.

§email_privacy_config: Option<Value>

Configuration for settings related to email privacy.

§client: Option<Value>

Options related to how clients making requests on behalf of a project should be configured.

Trait Implementations§

impl Debug for Tenant

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

Formats the value using the given formatter. Read more

impl Default for Tenant

fn default() -> Tenant

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Tenant

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Tenant

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for Tenant

impl RefUnwindSafe for Tenant

impl Send for Tenant

impl Sync for Tenant

impl Unpin for Tenant

impl UnwindSafe for Tenant

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,