Struct okta::user_factors::UserFactors

source · [−]

pub struct UserFactors {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl UserFactors

source

pub async fn list_factors(&self, user_id: &str) -> Result<Vec<UserFactor>>

This function performs a GET to the /api/v1/users/{userId}/factors endpoint.

Enumerates all the enrolled factors for the specified user

Parameters:

user_id: &str

source

pub async fn list_all_factors(&self, user_id: &str) -> Result<Vec<UserFactor>>

This function performs a GET to the /api/v1/users/{userId}/factors endpoint.

As opposed to list_factors, this function returns all the pages of the request at once.

Enumerates all the enrolled factors for the specified user

source

pub async fn enroll_factor(
 &self,
 user_id: &str,
 update_phone: bool,
 template_id: &str,
 token_lifetime_seconds: i64,
 activate: bool,
 body: &UserFactor
) -> Result<UserFactor>

Enroll Factor.

This function performs a POST to the /api/v1/users/{userId}/factors endpoint.

Enrolls a user with a supported factor.

Parameters:

user_id: &str
update_phone: bool
template_id: &str – id of SMS template (only for SMS factor).
token_lifetime_seconds: i64
activate: bool

source

pub async fn list_supported_factors(
&self,
user_id: &str
) -> Result<Vec<UserFactor>>

This function performs a GET to the /api/v1/users/{userId}/factors/catalog endpoint.

Enumerates all the supported factors that can be enrolled for the specified user

Parameters:

user_id: &str

source

pub async fn list_all_supported_factors(
&self,
user_id: &str
) -> Result<Vec<UserFactor>>

This function performs a GET to the /api/v1/users/{userId}/factors/catalog endpoint.

As opposed to list_supported_factors, this function returns all the pages of the request at once.

Enumerates all the supported factors that can be enrolled for the specified user

source

pub async fn list_supported_security_questions(
&self,
user_id: &str
) -> Result<Vec<SecurityQuestion>>

This function performs a GET to the /api/v1/users/{userId}/factors/questions endpoint.

Enumerates all available security questions for a user’s question factor

Parameters:

user_id: &str

source

pub async fn list_all_supported_security_questions(
&self,
user_id: &str
) -> Result<Vec<SecurityQuestion>>

This function performs a GET to the /api/v1/users/{userId}/factors/questions endpoint.

As opposed to list_supported_security_questions, this function returns all the pages of the request at once.

Enumerates all available security questions for a user’s question factor

source

pub async fn get_factor(
 &self,
 user_id: &str,
 factor_id: &str
) -> Result<UserFactor>

This function performs a GET to the /api/v1/users/{userId}/factors/{factorId} endpoint.

Fetches a factor for the specified user

Parameters:

user_id: &str
factor_id: &str

source

pub async fn delete_factor(&self, user_id: &str, factor_id: &str) -> Result<()>

This function performs a DELETE to the /api/v1/users/{userId}/factors/{factorId} endpoint.

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

Parameters:

user_id: &str
factor_id: &str

source

pub async fn activate_factor(
 &self,
 user_id: &str,
 factor_id: &str,
 body: &ActivateFactorRequest
) -> Result<UserFactor>

Activate Factor.

This function performs a POST to the /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate endpoint.

The sms and token:software:totp factor types require activation to complete the enrollment process.

Parameters:

user_id: &str
factor_id: &str

source

pub async fn get_factor_transaction_status(
 &self,
 user_id: &str,
 factor_id: &str,
 transaction_id: &str
) -> Result<VerifyUserFactorResponse>

This function performs a GET to the /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId} endpoint.

Polls factors verification transaction for status.

Parameters:

user_id: &str
factor_id: &str
transaction_id: &str

source

pub async fn verify_factor(
 &self,
 user_id: &str,
 factor_id: &str,
 template_id: &str,
 token_lifetime_seconds: i64,
 body: &VerifyFactorRequest
) -> Result<VerifyUserFactorResponse>

Verify MFA Factor.

This function performs a POST to the /api/v1/users/{userId}/factors/{factorId}/verify endpoint.

Verifies an OTP for a token or token:hardware factor

Parameters:

user_id: &str
factor_id: &str
template_id: &str
token_lifetime_seconds: i64
x_forwarded_for: &str
user_agent: &str
accept_language: &str

Auto Trait Implementations

impl !RefUnwindSafe for UserFactors

impl Send for UserFactors

impl Sync for UserFactors

impl Unpin for UserFactors

impl !UnwindSafe for UserFactors

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

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

Struct okta::user_factors::UserFactors

Fields

Implementations

impl UserFactors

pub async fn list_factors(&self, user_id: &str) -> Result<Vec<UserFactor>>

pub async fn list_all_factors(&self, user_id: &str) -> Result<Vec<UserFactor>>

pub async fn enroll_factor( &self, user_id: &str, update_phone: bool, template_id: &str, token_lifetime_seconds: i64, activate: bool, body: &UserFactor) -> Result<UserFactor>

pub async fn list_supported_factors( &self, user_id: &str) -> Result<Vec<UserFactor>>

pub async fn list_all_supported_factors( &self, user_id: &str) -> Result<Vec<UserFactor>>

pub async fn list_supported_security_questions( &self, user_id: &str) -> Result<Vec<SecurityQuestion>>

pub async fn list_all_supported_security_questions( &self, user_id: &str) -> Result<Vec<SecurityQuestion>>

pub async fn get_factor( &self, user_id: &str, factor_id: &str) -> Result<UserFactor>

pub async fn delete_factor(&self, user_id: &str, factor_id: &str) -> Result<()>

pub async fn activate_factor( &self, user_id: &str, factor_id: &str, body: &ActivateFactorRequest) -> Result<UserFactor>

pub async fn get_factor_transaction_status( &self, user_id: &str, factor_id: &str, transaction_id: &str) -> Result<VerifyUserFactorResponse>

pub async fn verify_factor( &self, user_id: &str, factor_id: &str, template_id: &str, token_lifetime_seconds: i64, body: &VerifyFactorRequest) -> Result<VerifyUserFactorResponse>

Auto Trait Implementations

impl !RefUnwindSafe for UserFactors

impl Send for UserFactors

impl Sync for UserFactors

impl Unpin for UserFactors

impl !UnwindSafe for UserFactors

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn enroll_factor(
&self,
user_id: &str,
update_phone: bool,
template_id: &str,
token_lifetime_seconds: i64,
activate: bool,
body: &UserFactor
) -> Result<UserFactor>

pub async fn list_supported_factors(
&self,
user_id: &str
) -> Result<Vec<UserFactor>>

pub async fn list_all_supported_factors(
&self,
user_id: &str
) -> Result<Vec<UserFactor>>

pub async fn list_supported_security_questions(
&self,
user_id: &str
) -> Result<Vec<SecurityQuestion>>

pub async fn list_all_supported_security_questions(
&self,
user_id: &str
) -> Result<Vec<SecurityQuestion>>

pub async fn get_factor(
&self,
user_id: &str,
factor_id: &str
) -> Result<UserFactor>

pub async fn activate_factor(
&self,
user_id: &str,
factor_id: &str,
body: &ActivateFactorRequest
) -> Result<UserFactor>

pub async fn get_factor_transaction_status(
&self,
user_id: &str,
factor_id: &str,
transaction_id: &str
) -> Result<VerifyUserFactorResponse>

pub async fn verify_factor(
&self,
user_id: &str,
factor_id: &str,
template_id: &str,
token_lifetime_seconds: i64,
body: &VerifyFactorRequest
) -> Result<VerifyUserFactorResponse>

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

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

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

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

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

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

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

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