Skip to content

Latest commit

 

History

History
66 lines (60 loc) · 6.27 KB

UpdateUserRequest.md

File metadata and controls

66 lines (60 loc) · 6.27 KB

ClerkHttpClient::UpdateUserRequest

Properties

Name Type Description Notes
external_id String The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. [optional]
first_name String The first name to assign to the user [optional]
last_name String The last name to assign to the user [optional]
primary_email_address_id String The ID of the email address to set as primary. It must be verified, and present on the current user. [optional]
notify_primary_email_address_changed Boolean If set to `true`, the user will be notified that their primary email address has changed. By default, no notification is sent. [optional][default to false]
primary_phone_number_id String The ID of the phone number to set as primary. It must be verified, and present on the current user. [optional]
primary_web3_wallet_id String The ID of the web3 wallets to set as primary. It must be verified, and present on the current user. [optional]
username String The username to give to the user. It must be unique across your instance. [optional]
profile_image_id String The ID of the image to set as the user's profile image [optional]
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. [optional]
password_digest 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. [optional]
password_hasher 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. [optional]
skip_password_checks Boolean 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`. [optional]
sign_out_of_other_sessions Boolean 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`. [optional]
totp_secret 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 [optional]
backup_codes Array<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. [optional]
public_metadata Object Metadata saved on the user, that is visible to both your Frontend and Backend APIs [optional]
private_metadata Object Metadata saved on the user, that is only visible to your Backend API [optional]
unsafe_metadata 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. [optional]
delete_self_enabled Boolean If true, the user can delete themselves with the Frontend API. [optional]
create_organization_enabled Boolean If true, the user can create organizations with the Frontend API. [optional]
legal_accepted_at String A custom timestamps denoting when the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). [optional]
skip_legal_checks Boolean 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. [optional]
create_organizations_limit Integer The maximum number of organizations the user can create. 0 means unlimited. [optional]
created_at 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`). [optional]

Example

require 'clerk-http-client'

instance = ClerkHttpClient::UpdateUserRequest.new(
  external_id: null,
  first_name: null,
  last_name: null,
  primary_email_address_id: null,
  notify_primary_email_address_changed: null,
  primary_phone_number_id: null,
  primary_web3_wallet_id: null,
  username: null,
  profile_image_id: null,
  password: null,
  password_digest: null,
  password_hasher: null,
  skip_password_checks: null,
  sign_out_of_other_sessions: null,
  totp_secret: null,
  backup_codes: null,
  public_metadata: null,
  private_metadata: null,
  unsafe_metadata: null,
  delete_self_enabled: null,
  create_organization_enabled: null,
  legal_accepted_at: null,
  skip_legal_checks: null,
  create_organizations_limit: null,
  created_at: null
)