| Field | Type | Required | Description | Example |
|---|---|---|---|---|
ExternalId |
string | ➖ | The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. |
ext_123 |
FirstName |
string | ➖ | The first name to assign to the user | Jane |
LastName |
string | ➖ | The last name to assign to the user | Doe |
PrimaryEmailAddressId |
string | ➖ | The ID of the email address to set as primary. It must be verified, and present on the current user. |
eml_12345 |
NotifyPrimaryEmailAddressChanged |
bool | ➖ | If set to true, the user will be notified that their primary email address has changed.By default, no notification is sent. |
true |
PrimaryPhoneNumberId |
string | ➖ | The ID of the phone number to set as primary. It must be verified, and present on the current user. |
phn_67890 |
PrimaryWeb3WalletId |
string | ➖ | The ID of the web3 wallets to set as primary. It must be verified, and present on the current user. |
wlt_123 |
Username |
string | ➖ | The username to give to the user. It must be unique across your instance. |
janedoe |
ProfileImageId |
string | ➖ | The ID of the image to set as the user's profile image | img_789 |
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. |
secretPass123! |
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. |
$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc |
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. |
|
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. |
false |
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. |
true |
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 |
ABCD1234EFGH5678 |
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. |
[ "123456", "654321" ] |
PublicMetadata |
Dictionary<String, object> | ➖ | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | { "theme": "dark" } |
PrivateMetadata |
Dictionary<String, object> | ➖ | Metadata saved on the user, that is only visible to your Backend API | { "vip": true } |
UnsafeMetadata |
Dictionary<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. |
{ "age": 30 } |
DeleteSelfEnabled |
bool | ➖ | If true, the user can delete themselves with the Frontend API. | true |
CreateOrganizationEnabled |
bool | ➖ | If true, the user can create organizations with the Frontend API. | false |
LegalAcceptedAt |
string | ➖ | A custom timestamps denoting when the user accepted legal requirements, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z). |
|
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. |
|
CreateOrganizationsLimit |
long | ➖ | The maximum number of organizations the user can create. 0 means unlimited. | |
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). |
2021-04-05T14:30:00.000Z |