clerk_sdk_rust_community/models/create_user_request.rs
1/*
2 * Clerk Backend API
3 *
4 * The Clerk REST Backend API, meant to be accessed by backend servers. Please see https://clerk.com/docs for more information.
5 *
6 * The version of the OpenAPI document: v1
7 * Contact: support@clerk.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13
14#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
15pub struct CreateUserRequest {
16 /// The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.
17 #[serde(rename = "external_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
18 pub external_id: Option<Option<String>>,
19 /// The first name to assign to the user
20 #[serde(rename = "first_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
21 pub first_name: Option<Option<String>>,
22 /// The last name to assign to the user
23 #[serde(rename = "last_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
24 pub last_name: Option<Option<String>>,
25 /// 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.
26 #[serde(rename = "email_address", skip_serializing_if = "Option::is_none")]
27 pub email_address: Option<Vec<String>>,
28 /// 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.
29 #[serde(rename = "phone_number", skip_serializing_if = "Option::is_none")]
30 pub phone_number: Option<Vec<String>>,
31 /// 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.
32 #[serde(rename = "web3_wallet", skip_serializing_if = "Option::is_none")]
33 pub web3_wallet: Option<Vec<String>>,
34 /// The username to give to the user. It must be unique across your instance.
35 #[serde(rename = "username", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
36 pub username: Option<Option<String>>,
37 /// The plaintext password to give the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.
38 #[serde(rename = "password", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
39 pub password: Option<Option<String>>,
40 /// 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.
41 #[serde(rename = "password_digest", skip_serializing_if = "Option::is_none")]
42 pub password_digest: Option<String>,
43 /// The hashing algorithm that was used to generate the password digest. The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), md5, pbkdf2_sha256, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/) and 2 [argon2](https://argon2.online/) variants, argon2i and argon2id. Each of the above expects the incoming digest to be of a particular format. More specifically: **bcrypt:** The digest should be of the following form: `$<algorithm version>$<cost>$<salt & hash>` **md5:** The digest should follow the regular form e.g.: `5f4dcc3b5aa765d61d8327deb882cf99` **pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows: `pbkdf2_sha256$<iterations>$<salt>$<hash>` Note: Both the salt and the hash are expected to be base64-encoded. **pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django): `pbkdf2_sha256$<iterations>$<salt>$<hash>` Note: The salt is expected to be un-encoded, the hash is expected base64-encoded. **pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences: 1. uses sha1 instead of sha256 2. accepts the hash as a hex-encoded string The format is the following: `pbkdf2_sha1$<iterations>$<salt>$<hash-as-hex-string>` **scrypt_firebase:** The Firebase-specific variant of scrypt. The value is expected to have 6 segments separated by the $ character and include the following information: _hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase. _salt:_ The salt used to generate the above hash. Again, this is given when exporting the user. _signer key:_ The base64 encoded signer key. _salt separator:_ The base64 encoded salt separator. _rounds:_ The number of rounds the algorithm needs to run. _memory cost:_ The cost of the algorithm run The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase. The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters. Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it: `<hash>$<salt>$<signer key>$<salt separator>$<rounds>$<memory cost>` **argon2i:** Algorithms in the argon2 family generate digests that encode the following information: _version (v):_ The argon version, version 19 is assumed _memory (m):_ The memory used by the algorithm (in kibibytes) _iterations (t):_ The number of iterations to perform _parallelism (p):_ The number of threads to use Parts are demarcated by the `$` character, with the first part identifying the algorithm variant. The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism). The final part is the actual digest. `$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc` **argon2id:** See the previous algorithm for an explanation of the formatting. For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`: `$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU` If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).
44 #[serde(rename = "password_hasher", skip_serializing_if = "Option::is_none")]
45 pub password_hasher: Option<PasswordHasher>,
46 /// 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.
47 #[serde(rename = "skip_password_checks", skip_serializing_if = "Option::is_none")]
48 pub skip_password_checks: Option<bool>,
49 /// 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.
50 #[serde(rename = "skip_password_requirement", skip_serializing_if = "Option::is_none")]
51 pub skip_password_requirement: Option<bool>,
52 /// 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
53 #[serde(rename = "totp_secret", skip_serializing_if = "Option::is_none")]
54 pub totp_secret: Option<String>,
55 /// 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.
56 #[serde(rename = "backup_codes", skip_serializing_if = "Option::is_none")]
57 pub backup_codes: Option<Vec<String>>,
58 /// Metadata saved on the user, that is visible to both your Frontend and Backend APIs
59 #[serde(rename = "public_metadata", skip_serializing_if = "Option::is_none")]
60 pub public_metadata: Option<serde_json::Value>,
61 /// Metadata saved on the user, that is only visible to your Backend API
62 #[serde(rename = "private_metadata", skip_serializing_if = "Option::is_none")]
63 pub private_metadata: Option<serde_json::Value>,
64 /// 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.
65 #[serde(rename = "unsafe_metadata", skip_serializing_if = "Option::is_none")]
66 pub unsafe_metadata: Option<serde_json::Value>,
67 /// 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`).
68 #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")]
69 pub created_at: Option<String>,
70}
71
72impl CreateUserRequest {
73 pub fn new() -> CreateUserRequest {
74 CreateUserRequest {
75 external_id: None,
76 first_name: None,
77 last_name: None,
78 email_address: None,
79 phone_number: None,
80 web3_wallet: None,
81 username: None,
82 password: None,
83 password_digest: None,
84 password_hasher: None,
85 skip_password_checks: None,
86 skip_password_requirement: None,
87 totp_secret: None,
88 backup_codes: None,
89 public_metadata: None,
90 private_metadata: None,
91 unsafe_metadata: None,
92 created_at: None,
93 }
94 }
95}
96
97/// The hashing algorithm that was used to generate the password digest. The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), md5, pbkdf2_sha256, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/) and 2 [argon2](https://argon2.online/) variants, argon2i and argon2id. Each of the above expects the incoming digest to be of a particular format. More specifically: **bcrypt:** The digest should be of the following form: `$<algorithm version>$<cost>$<salt & hash>` **md5:** The digest should follow the regular form e.g.: `5f4dcc3b5aa765d61d8327deb882cf99` **pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows: `pbkdf2_sha256$<iterations>$<salt>$<hash>` Note: Both the salt and the hash are expected to be base64-encoded. **pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django): `pbkdf2_sha256$<iterations>$<salt>$<hash>` Note: The salt is expected to be un-encoded, the hash is expected base64-encoded. **pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences: 1. uses sha1 instead of sha256 2. accepts the hash as a hex-encoded string The format is the following: `pbkdf2_sha1$<iterations>$<salt>$<hash-as-hex-string>` **scrypt_firebase:** The Firebase-specific variant of scrypt. The value is expected to have 6 segments separated by the $ character and include the following information: _hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase. _salt:_ The salt used to generate the above hash. Again, this is given when exporting the user. _signer key:_ The base64 encoded signer key. _salt separator:_ The base64 encoded salt separator. _rounds:_ The number of rounds the algorithm needs to run. _memory cost:_ The cost of the algorithm run The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase. The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters. Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it: `<hash>$<salt>$<signer key>$<salt separator>$<rounds>$<memory cost>` **argon2i:** Algorithms in the argon2 family generate digests that encode the following information: _version (v):_ The argon version, version 19 is assumed _memory (m):_ The memory used by the algorithm (in kibibytes) _iterations (t):_ The number of iterations to perform _parallelism (p):_ The number of threads to use Parts are demarcated by the `$` character, with the first part identifying the algorithm variant. The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism). The final part is the actual digest. `$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc` **argon2id:** See the previous algorithm for an explanation of the formatting. For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`: `$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU` If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).
98#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
99pub enum PasswordHasher {
100 #[serde(rename = "bcrypt")]
101 Bcrypt,
102 #[serde(rename = "md5")]
103 Md5,
104 #[serde(rename = "pbkdf2_sha256")]
105 Pbkdf2Sha256,
106 #[serde(rename = "pbkdf2_sha256_django")]
107 Pbkdf2Sha256Django,
108 #[serde(rename = "pbkdf2_sha1")]
109 Pbkdf2Sha1,
110 #[serde(rename = "scrypt_firebase")]
111 ScryptFirebase,
112 #[serde(rename = "argon2i")]
113 Argon2i,
114 #[serde(rename = "argon2id")]
115 Argon2id,
116}
117
118impl Default for PasswordHasher {
119 fn default() -> PasswordHasher {
120 Self::Bcrypt
121 }
122}
123