README.md

Rust API client for bitwarden-api-identity

Updating bindings after a server API change

When a server API change is made, new bindings will need to be generated to reflect this change for consumption in the SDK.

This can be done the following ways:

1. Wait for an automatic binding update to run, which is scheduled every 2 weeks.
2. Manually run the Update API Bindings workflow in the sdk-internal repo.

Both of these will generate a PR that will require approval from any teams whose owned code is affected by the binding updates.

Current binding details

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 3.0.0
• Server Git commit: 1581b9b490976f9dcc351d14aae77f83235222c6
• Generator version: 7.15.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Documentation for API endpoints

All URIs are relative to https://identity.bitwarden.com

Class	Method	HTTP request	Description
AccountsApi	get_web_authn_login_assertion_options	GET /accounts/webauthn/assertion-options
AccountsApi	post_password_prelogin	POST /accounts/prelogin/password
AccountsApi	post_register_finish	POST /accounts/register/finish
AccountsApi	post_register_send_verification_email	POST /accounts/register/send-verification-email
AccountsApi	post_register_verification_email_clicked	POST /accounts/register/verification-email-clicked
AccountsApi	post_trial_initiation_send_verification_email	POST /accounts/trial/send-verification-email
InfoApi	get_alive	GET /alive
SsoApi	external_callback	GET /sso/ExternalCallback
SsoApi	external_challenge	GET /sso/ExternalChallenge
SsoApi	login	GET /sso/Login
SsoApi	pre_validate	GET /sso/PreValidate

Documentation For Models

• AccountKeysRequestModel
• AssertionOptions
• AuthenticationExtensionsClientInputs
• AuthenticatorTransport
• KdfRequestModel
• KdfSettings
• KdfType
• KeysRequestModel
• MasterPasswordAuthenticationDataRequestModel
• MasterPasswordUnlockDataRequestModel
• OpenOrgInviteRequestModel
• PasswordPreloginRequestModel
• PasswordPreloginResponseModel
• ProductTierType
• ProductType
• PublicKeyCredentialDescriptor
• PublicKeyCredentialType
• PublicKeyEncryptionKeyPairRequestModel
• RegisterFinishRequestModel
• RegisterFinishResponseModel
• RegisterSendVerificationEmailRequestModel
• RegisterStartOpenOrgInviteRequestModel
• RegisterVerificationEmailClickedRequestModel
• SecurityStateModel
• SignatureKeyPairRequestModel
• TrialSendVerificationEmailRequestModel
• UserVerificationRequirement
• WebAuthnLoginAssertionOptionsResponseModel

To get access to the crate's generated documentation, use:

cargo doc --open