Struct LoginSuccessResponse 

pub struct LoginSuccessResponse {
    pub access_token: String,
    pub expires_in: u64,
    pub expires_at: i64,
    pub scope: String,
    pub token_type: String,
    pub refresh_token: Option<String>,
    pub user_key_wrapped_user_private_key: Option<String>,
    pub two_factor_token: Option<String>,
    pub force_password_reset: Option<bool>,
    pub api_use_key_connector: Option<bool>,
    pub user_decryption_options: UserDecryptionOptionsResponse,
    pub master_password_policy: Option<MasterPasswordPolicyResponse>,
}

SDK response model for a successful login. This is the model that will be exposed to consuming applications.

Fields

access_token: String

The access token string.

expires_in: u64

The duration in seconds until the token expires.

expires_at: i64

The timestamp in milliseconds when the token expires. We calculate this for more convenient token expiration handling.

scope: String

The scope of the access token. OAuth 2.0 RFC reference: https://datatracker.ietf.org/doc/html/rfc6749#section-3.3

token_type: String

The type of the token. This will be “Bearer” for send access tokens. OAuth 2.0 RFC reference: https://datatracker.ietf.org/doc/html/rfc6749#section-7.1

refresh_token: Option<String>

The optional refresh token string. This token can be used to obtain new access tokens when the current one expires.

user_key_wrapped_user_private_key: Option<String>

The user key wrapped user private key. Note: previously known as “private_key”.

two_factor_token: Option<String>

Two-factor authentication token for future requests.

force_password_reset: Option<bool>

Indicates whether an admin has reset the user’s master password, requiring them to set a new password upon next login.

api_use_key_connector: Option<bool>

Indicates whether the user uses Key Connector and if the client should have a locally configured Key Connector URL in their environment. Note: This is currently only applicable for client_credential grant type logins and is only expected to be relevant for the CLI

user_decryption_options: UserDecryptionOptionsResponse

The user’s decryption options for unlocking their vault.

master_password_policy: Option<MasterPasswordPolicyResponse>

If the user is subject to an organization master password policy, this field contains the requirements of that policy.

Trait Implementations

impl Clone for LoginSuccessResponse

fn clone(&self) -> LoginSuccessResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for LoginSuccessResponse

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for LoginSuccessResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginSuccessResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for LoginSuccessResponse

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<LoginSuccessResponse> for JsValue

where LoginSuccessResponse: Serialize,

fn from(value: LoginSuccessResponse) -> Self

Converts to this type from the input type.

impl FromWasmAbi for LoginSuccessResponse

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for &LoginSuccessResponse

where LoginSuccessResponse: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for LoginSuccessResponse

where LoginSuccessResponse: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for LoginSuccessResponse

type FfiType = <LoginSuccessResponse as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for LoginSuccessResponse

type LiftType = LoginSuccessResponse

impl<UT> LiftReturn<UT> for LoginSuccessResponse

type ReturnType = <LoginSuccessResponse as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for LoginSuccessResponse

type FfiType = <LoginSuccessResponse as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for LoginSuccessResponse

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for LoginSuccessResponse

type ReturnType = <LoginSuccessResponse as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for LoginSuccessResponse

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for LoginSuccessResponse

where LoginSuccessResponse: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for LoginSuccessResponse

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<LoginSuccessResponse>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Serialize for LoginSuccessResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<LoginSuccessApiResponse> for LoginSuccessResponse

type Error = MasterPasswordError

The type returned in the event of a conversion error.

fn try_from(response: LoginSuccessApiResponse) -> Result<Self, Self::Error>

Performs the conversion.

impl Tsify for LoginSuccessResponse

const DECL: &'static str = "/**\n * SDK response model for a successful login.\n * This is the model that will be exposed to consuming applications.\n */\nexport interface LoginSuccessResponse {\n /**\n * The access token string.\n */\n accessToken: string;\n /**\n * The duration in seconds until the token expires.\n */\n expiresIn: number;\n /**\n * The timestamp in milliseconds when the token expires.\n * We calculate this for more convenient token expiration handling.\n */\n expiresAt: number;\n /**\n * The scope of the access token.\n * OAuth 2.0 RFC reference: <https://datatracker.ietf.org/doc/html/rfc6749#section-3.3>\n */\n scope: string;\n /**\n * The type of the token.\n * This will be \\\"Bearer\\\" for send access tokens.\n * OAuth 2.0 RFC reference: <https://datatracker.ietf.org/doc/html/rfc6749#section-7.1>\n */\n tokenType: string;\n /**\n * The optional refresh token string.\n * This token can be used to obtain new access tokens when the current one expires.\n */\n refreshToken: string | undefined;\n /**\n * The user key wrapped user private key.\n * Note: previously known as \\\"private_key\\\".\n */\n userKeyWrappedUserPrivateKey: string | undefined;\n /**\n * Two-factor authentication token for future requests.\n */\n twoFactorToken: string | undefined;\n /**\n * Indicates whether an admin has reset the user\\\'s master password,\n * requiring them to set a new password upon next login.\n */\n forcePasswordReset: boolean | undefined;\n /**\n * Indicates whether the user uses Key Connector and if the client should have a locally\n * configured Key Connector URL in their environment.\n * Note: This is currently only applicable for client_credential grant type logins and\n * is only expected to be relevant for the CLI\n */\n apiUseKeyConnector: boolean | undefined;\n /**\n * The user\\\'s decryption options for unlocking their vault.\n */\n userDecryptionOptions: UserDecryptionOptionsResponse;\n /**\n * If the user is subject to an organization master password policy,\n * this field contains the requirements of that policy.\n */\n masterPasswordPolicy: MasterPasswordPolicyResponse | undefined;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl<UT> TypeId<UT> for LoginSuccessResponse

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for LoginSuccessResponse

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for LoginSuccessResponse

where LoginSuccessResponse: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for LoginSuccessResponse

fn describe()

impl WasmDescribeVector for LoginSuccessResponse

fn describe_vector()