Struct UpdateUserRequest

pub struct UpdateUserRequest {

    pub external_id: Option<Option<String>>,
    pub first_name: Option<Option<String>>,
    pub last_name: Option<Option<String>>,
    pub primary_email_address_id: Option<String>,
    pub notify_primary_email_address_changed: Option<bool>,
    pub primary_phone_number_id: Option<String>,
    pub primary_web3_wallet_id: Option<String>,
    pub username: Option<Option<String>>,
    pub profile_image_id: Option<Option<String>>,
    pub password: Option<Option<String>>,
    pub skip_password_checks: Option<Option<bool>>,
    pub sign_out_of_other_sessions: Option<Option<bool>>,
    pub totp_secret: Option<String>,
    pub backup_codes: Option<Vec<String>>,
    pub public_metadata: Option<Value>,
    pub private_metadata: Option<Value>,
    pub unsafe_metadata: Option<Value>,
    pub delete_self_enabled: Option<Option<bool>>,
    pub create_organization_enabled: Option<Option<bool>>,
    pub created_at: Option<String>,
}

Fields

external_id: Option<Option<String>>

The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.

first_name: Option<Option<String>>

The first name to assign to the user

last_name: Option<Option<String>>

The last name to assign to the user

primary_email_address_id: Option<String>

The ID of the email address to set as primary. It must be verified, and present on the current user.

notify_primary_email_address_changed: Option<bool>

If set to true, the user will be notified that their primary email address has changed. By default, no notification is sent.

primary_phone_number_id: Option<String>

The ID of the phone number to set as primary. It must be verified, and present on the current user.

primary_web3_wallet_id: Option<String>

The ID of the web3 wallets to set as primary. It must be verified, and present on the current user.

username: Option<Option<String>>

The username to give to the user. It must be unique across your instance.

profile_image_id: Option<Option<String>>

The ID of the image to set as the user’s profile image

password: Option<Option<String>>

The plaintext password to give the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.

skip_password_checks: Option<Option<bool>>

Set it to true if you’re updating the user’s password and want to skip any password policy settings check. This parameter can only be used when providing a password.

sign_out_of_other_sessions: Option<Option<bool>>

Set to true to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a password.

totp_secret: Option<String>

In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it. Please note that currently the supported options are: * Period: 30 seconds * Code length: 6 digits * Algorithm: SHA1

backup_codes: Option<Vec<String>>

If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest.

public_metadata: Option<Value>

Metadata saved on the user, that is visible to both your Frontend and Backend APIs

private_metadata: Option<Value>

Metadata saved on the user, that is only visible to your Backend API

unsafe_metadata: Option<Value>

Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.

delete_self_enabled: Option<Option<bool>>

If true, the user can delete themselves with the Frontend API.

create_organization_enabled: Option<Option<bool>>

If true, the user can create organizations with the Frontend API.

created_at: Option<String>

A custom date/time denoting when the user signed up to the application, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).

Implementations

impl UpdateUserRequest

pub fn new() -> UpdateUserRequest

Trait Implementations

impl Clone for UpdateUserRequest

fn clone(&self) -> UpdateUserRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateUserRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateUserRequest

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

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 UpdateUserRequest