Skip to main content

SettingsClient

Struct SettingsClient 

Source
pub struct SettingsClient { /* private fields */ }
Expand description

Access to the /v1/gate/settings endpoints.

Obtain via Gate::settings.

Implementations§

Source§

impl SettingsClient

Source

pub async fn get_security(&self) -> Result<SecuritySettings, Error>

Fetch the tenant’s security settings (passwordless / MFA).

Maps to GET /v1/gate/settings/security.

Source

pub async fn update_security( &self, settings: SecuritySettings, ) -> Result<(), Error>

Replace the tenant’s security settings.

Both fields are always sent — the update is a full replacement, not a merge. Maps to PUT /v1/gate/settings/security.

§Example
use nautilus_rs::{Gate, SecuritySettings};

let gate = Gate::new("vrn_gate_live_sk_…");
gate.settings().update_security(SecuritySettings {
    passwordless_enabled: true,
    mfa_enabled: false,
}).await?;
Source

pub async fn get_oidc_providers(&self) -> Result<Vec<OidcProvider>, Error>

List the tenant’s social login (OIDC) providers and whether each is enabled — covering every provider Gate supports, regardless of state.

Maps to GET /v1/gate/settings/oidc-providers.

Source

pub async fn update_oidc_providers( &self, providers: Vec<OidcProvider>, ) -> Result<Vec<OidcProvider>, Error>

Set the enabled flag for one or more social login providers.

Any provider omitted from providers is left unchanged. Returns the full, updated provider list. Maps to PUT /v1/gate/settings/oidc-providers.

§Example
use nautilus_rs::{Gate, OidcProvider};

let gate = Gate::new("vrn_gate_live_sk_…");
let providers = gate.settings().update_oidc_providers(vec![
    OidcProvider { provider: "github".into(), enabled: true },
    OidcProvider { provider: "google".into(), enabled: true },
]).await?;

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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