Struct authy::user::User
[−]
[src]
pub struct User { pub id: u32, pub registered: bool, pub confirmed: bool, pub account_disabled: bool, pub country_code: u16, pub phone_number: String, pub has_hard_token: bool, pub devices: Vec<String>, }
An Authy user as part of the 'high level' Authy interface.
Please see api::user for more details.
Fields
id: u32
The authy id for the user.
registered: bool
true when the Authy Mobile/Desktop App was registered.
confirmed: bool
true when the user has used a valid code before.
account_disabled: bool
Has the account been marked for deletion
country_code: u16
The country code listed for the user.
phone_number: String
The last 4 of the phone number registered to the account.
has_hard_token: bool
(Unknown, API documentation doesn't list)
devices: Vec<String>
List of devices, options are: android, android_tablet, ios, authy_chrome, sms.
Methods
impl User
[src]
fn create(
c: &Client,
email: &str,
country_code: u16,
phone: &str,
send_instructions: bool
) -> Result<User, AuthyError>
c: &Client,
email: &str,
country_code: u16,
phone: &str,
send_instructions: bool
) -> Result<User, AuthyError>
Create a new user with the Authy service. Returns a User
populated
with data from the 'status' API call. The id returned must be stored
and used future interactions with Authy for the user.
Please see api::user::create
fn find(c: &Client, id: u32) -> Result<User, AuthyError>
Returns a User
populated with data from the status
API call for the
given authy id.
Please see api::user::status
fn update(&mut self, c: &Client) -> Result<(), AuthyError>
Updates the User
with the latest data from authy's service.
Please see api::user::status
fn delete(&mut self, c: &Client) -> Result<(), AuthyError>
Marks a user for deletion.
Please see api::user::delete
fn verify(&mut self, c: &Client, token: &str) -> Result<bool, AuthyError>
Perform a verification request. Returns Ok(true) for a successful verification and Ok(false) when the verification code was invalid.
Please see api::user::verify
fn sms(
&self,
c: &Client,
force: bool,
action: Option<&str>,
action_message: Option<&str>
) -> Result<PhoneCall, AuthyError>
&self,
c: &Client,
force: bool,
action: Option<&str>,
action_message: Option<&str>
) -> Result<PhoneCall, AuthyError>
Requests that the Authy service send the user a verification code over SMS. This request will be ignored if the user is using the Authy Mobile app unless force is set to true.
Please see api::user::sms
fn call(
&self,
c: &Client,
force: bool,
action: Option<&str>,
action_message: Option<&str>
) -> Result<PhoneCall, AuthyError>
&self,
c: &Client,
force: bool,
action: Option<&str>,
action_message: Option<&str>
) -> Result<PhoneCall, AuthyError>
Requests that the Authy service send the user a verification code over the phone. This request will be ignored if the user is using the Authy Mobile app unless force is set to true.
Please see api::user::call
fn register_activity(
&self,
c: &Client,
data: Option<&HashMap<&str, String>>,
activity_type: ActivityType,
user_ip: &str
) -> Result<(), AuthyError>
&self,
c: &Client,
data: Option<&HashMap<&str, String>>,
activity_type: ActivityType,
user_ip: &str
) -> Result<(), AuthyError>
Optionally, you can register some of the activities that your user do on your application. This helps us to identify fraudulent behaviours. For example if you register that a user reset his password and then he tries to change his phone with Authy we can know that something weird is happening.
Please see api::user::register_activity
Trait Implementations
impl Debug for User
[src]
impl Clone for User
[src]
fn clone(&self) -> User
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more