UpdateUserRequest class
Constructors
UpdateUserRequest.new ({String ? externalId , String ? firstName , String ? lastName , String ? primaryEmailAddressId , bool ? notifyPrimaryEmailAddressChanged = false , String ? primaryPhoneNumberId , String ? primaryWeb3WalletId , String ? username , String ? profileImageId , String ? password , String ? passwordDigest , String ? passwordHasher , bool ? skipPasswordChecks , bool ? signOutOfOtherSessions , String ? totpSecret , List <String > backupCodes = const [] , Map <String , Object > ? publicMetadata = const {} , Map <String , Object > ? privateMetadata = const {} , Map <String , Object > ? unsafeMetadata = const {} , bool ? deleteSelfEnabled , bool ? createOrganizationEnabled , String ? legalAcceptedAt , bool ? skipLegalChecks , int ? createOrganizationsLimit , String ? createdAt })
Returns a new UpdateUserRequest instance.
Properties
backupCodes
↔ List <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.
getter/setter pair
createdAt
↔ 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
).
getter/setter pair
createOrganizationEnabled
↔ bool ?
If true, the user can create organizations with the Frontend API.
getter/setter pair
createOrganizationsLimit
↔ int ?
The maximum number of organizations the user can create. 0 means unlimited.
getter/setter pair
deleteSelfEnabled
↔ bool ?
If true, the user can delete themselves with the Frontend API.
getter/setter pair
externalId
↔ String ?
The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.
getter/setter pair
firstName
↔ String ?
The first name to assign to the user
getter/setter pair
hashCode
→ int
The hash code for this object.
no setter override
lastName
↔ String ?
The last name to assign to the user
getter/setter pair
legalAcceptedAt
↔ String ?
A custom timestamps denoting when the user accepted legal requirements, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z
).
getter/setter pair
notifyPrimaryEmailAddressChanged
↔ bool ?
If set to true
, the user will be notified that their primary email address has changed. By default, no notification is sent.
getter/setter pair
password
↔ 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.
getter/setter pair
passwordDigest
↔ String ?
In case you already have the password digests and not the passwords, you can use them for the newly created user via this property. The digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the password_hasher
property.
getter/setter pair
passwordHasher
↔ String ?
The hashing algorithm that was used to generate the password digest. The algorithms we support at the moment are bcrypt
, bcrypt_sha256_django
, md5
, pbkdf2_sha1
, pbkdf2_sha256
, pbkdf2_sha256_django
, phpass
, scrypt_firebase
, scrypt_werkzeug
, sha256
, and the argon2
variants: argon2i
and argon2id
. Each of the supported hashers expects the incoming digest to be in a particular format. See the Clerk docs for more information.
getter/setter pair
primaryEmailAddressId
↔ String ?
The ID of the email address to set as primary. It must be verified, and present on the current user.
getter/setter pair
primaryPhoneNumberId
↔ String ?
The ID of the phone number to set as primary. It must be verified, and present on the current user.
getter/setter pair
primaryWeb3WalletId
↔ String ?
The ID of the web3 wallets to set as primary. It must be verified, and present on the current user.
getter/setter pair
privateMetadata
↔ Map <String , Object > ?
Metadata saved on the user, that is only visible to your Backend API
getter/setter pair
profileImageId
↔ String ?
The ID of the image to set as the user's profile image
getter/setter pair
publicMetadata
↔ Map <String , Object > ?
Metadata saved on the user, that is visible to both your Frontend and Backend APIs
getter/setter pair
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
signOutOfOtherSessions
↔ 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
.
getter/setter pair
skipLegalChecks
↔ bool ?
When set to true
all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk.
getter/setter pair
skipPasswordChecks
↔ 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
.
getter/setter pair
totpSecret
↔ 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
getter/setter pair
unsafeMetadata
↔ Map <String , Object > ?
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.
getter/setter pair
username
↔ String ?
The username to give to the user. It must be unique across your instance.
getter/setter pair