Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 120 KB

createuserrequestbody.md

File metadata and controls

30 lines (27 loc) · 120 KB

CreateUserRequestBody

Fields

Field Type Required Description Example
external_id OptionalNullable[str] ➖ The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance.		 ext-id-001
first_name OptionalNullable[str] ➖ The first name to assign to the user John
last_name OptionalNullable[str] ➖ The last name to assign to the user Doe
email_address List[str] ➖ Email addresses to add to the user.
Must be unique across your instance.
The first email address will be set as the user's primary email address.
phone_number List[str] ➖ Phone numbers to add to the user.
Must be unique across your instance.
The first phone number will be set as the user's primary phone number.
web3_wallet List[str] ➖ Web3 wallets to add to the user.
Must be unique across your instance.
The first wallet will be set as the user's primary wallet.
username OptionalNullable[str] ➖ The username to give to the user.
It must be unique across your instance.		 johndoe123
password OptionalNullable[str] ➖ The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords.		 Secure*Pass4
password_digest Optional[str] ➖ 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
password_hasher Optional[str] ➖ 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.
skip_password_checks Optional[bool] ➖ When set to true all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password.		 false
skip_password_requirement Optional[bool] ➖ When set to true, password is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance.		 false
totp_secret Optional[str] ➖ In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1		 base32totpsecretkey
backup_codes List[str] ➖ If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest.		 [
"123456",
"654321"
]
public_metadata Dict[str, Any] ➖ Metadata saved on the user, that is visible to both your Frontend and Backend APIs {
"role": "user"
}
private_metadata Dict[str, Any] ➖ Metadata saved on the user, that is only visible to your Backend API {
"internal_id": "789"
}
unsafe_metadata Dict[str, Any] ➖ 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.		 {
"preferences": {
"theme": "dark"
}
}
delete_self_enabled OptionalNullable[bool] ➖ If enabled, user can delete themselves via FAPI.
legal_accepted_at OptionalNullable[str] ➖ A custom timestamp denoting when the user accepted legal requirements, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).
skip_legal_checks OptionalNullable[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.
create_organization_enabled OptionalNullable[bool] ➖ If enabled, user can create organizations via FAPI.
create_organizations_limit OptionalNullable[int] ➖ The maximum number of organizations the user can create. 0 means unlimited.
created_at Optional[str] ➖ 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). 2023-03-15T07:15:20.902Z