Skip to main content

Module registration

Module registration 

Source
Expand description

The registration module provides the registration client and related type for registering new Bitwarden users via various cryptographic mechanisms to establish their cryptographic state and register with the Bitwarden server

Modulesยง

post_keys_for_jit_password_registration ๐Ÿ”’
Initializes a new cryptographic state for a user and posts it to the server; enrolls the user to master password unlock.
post_keys_for_key_connector_registration ๐Ÿ”’
Initializes a new cryptographic state for a user and posts it to the server; enrolls the user to key connector unlock.
post_keys_for_tde_registration ๐Ÿ”’
Initializes a new cryptographic state for a user and posts it to the server; enrolls in admin password reset and finally enrolls the user to TDE unlock.
post_keys_for_user_password_registration ๐Ÿ”’
Initializes new password-based cryptographic state for a user and posts the state to the server
registration_client ๐Ÿ”’
Client for account registration and cryptography initialization related API methods. It is used both for the initial registration request in the case of password registrations, and for cryptography initialization for a jit provisioned user. After a method on this client is called, the user account should have initialized account keys, an authentication method such as SSO or master password, and a decryption method such as key-connector, TDE, or master password.

Structsยง

JitMasterPasswordRegistrationRequest
Request parameters for SSO JIT master password registration.
JitMasterPasswordRegistrationResponse
Result of JIT master password registration process.
KeyConnectorRegistrationResult
Result of Key Connector registration process.
RegistrationClient
Client for initializing a user account.
TdeRegistrationRequest
Request parameters for TDE (Trusted Device Encryption) registration.
TdeRegistrationResponse
Result of TDE registration process.
UserMasterPasswordRegistrationRequest
Request parameters for master password registration
UserMasterPasswordRegistrationResponse
Result of user master password registration process.

Enumsยง

RegistrationError
Errors that can occur during user registration.