Class UserSignatures

Builder class for constructing user signatures in all kind of client requests to the network. It uses the API of AuthModule concrete types together with the challenge to generate the user signatures. Contains a map of UserAuthentication instances for different authentication payloads.

Index

Constructors

constructor

Methods

build setAddEphKeyUserSigs setFinishPresignUserSigs setKeygenUserSigs setKeyRefreshUserSigs setRegisterPasskeyUserSigs setRevokeEphKeyUserSigs setSigngenUserSigs

Constructors

constructor

new UserSignatures(
authModule: AuthModule,
apiVersion: ApiVersion,
): UserSignatures
Parameters
- authModule: AuthModule
- apiVersion: ApiVersion
Returns UserSignatures
- Defined in builder/userAuth.ts:25

Methods

build

build(
    slug: Slug,
    payload:
        | SignSetupOpts
        | InitPresignOpts
        | FinishPresignOpts
        | RevokeEphKeyRequest
        | AddEphKeyRequest
        | RegisterPasskeyRequest
        | KeyRefreshRequest
        | KeygenSetupOpts[],
    challenge?: string,
): Promise<Record<string, UserAuthentication>>
Parameters
- slug: Slug
- payload:
      | SignSetupOpts
      | InitPresignOpts
      | FinishPresignOpts
      | RevokeEphKeyRequest
      | AddEphKeyRequest
      | RegisterPasskeyRequest
      | KeyRefreshRequest
      | KeygenSetupOpts[]
- Optionalchallenge: string
Returns Promise<Record<string, UserAuthentication>>
- Defined in builder/userAuth.ts:101

setAddEphKeyUserSigs

setAddEphKeyUserSigs(
payload: AddEphKeyRequest,
challenge?: string,
): Promise<void>
Parameters
- payload: AddEphKeyRequest
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:70

setFinishPresignUserSigs

setFinishPresignUserSigs(
payload: FinishPresignOpts,
challenge?: string,
): Promise<void>
Parameters
- payload: FinishPresignOpts
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:98

setKeygenUserSigs

setKeygenUserSigs(
payload: KeygenSetupOpts[],
challenges?: { [key: string]: string },
): Promise<void>
Parameters
- payload: KeygenSetupOpts[]
- Optionalchallenges: { [key: string]: string }
Returns Promise<void>
- Defined in builder/userAuth.ts:39

setKeyRefreshUserSigs

setKeyRefreshUserSigs(
payload: KeyRefreshRequest,
challenge?: string,
): Promise<void>
Parameters
- payload: KeyRefreshRequest
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:91

setRegisterPasskeyUserSigs

setRegisterPasskeyUserSigs(
payload: RegisterPasskeyRequest,
challenge?: string,
): Promise<void>
Parameters
- payload: RegisterPasskeyRequest
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:84

setRevokeEphKeyUserSigs

setRevokeEphKeyUserSigs(
payload: RevokeEphKeyRequest,
challenge?: string,
): Promise<void>
Parameters
- payload: RevokeEphKeyRequest
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:77

setSigngenUserSigs

setSigngenUserSigs(payload: SignSetupOpts, challenge?: string): Promise<void>
Parameters
- payload: SignSetupOpts
- Optionalchallenge: string
Returns Promise<void>
- Defined in builder/userAuth.ts:63

Class UserSignatures

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserSignatures

Methods

build

Parameters

Returns Promise<Record<string, UserAuthentication>>

setAddEphKeyUserSigs

Parameters

Returns Promise<void>

setFinishPresignUserSigs

Parameters

Returns Promise<void>

setKeygenUserSigs

Parameters

Returns Promise<void>

setKeyRefreshUserSigs

Parameters

Returns Promise<void>

setRegisterPasskeyUserSigs

Parameters

Returns Promise<void>

setRevokeEphKeyUserSigs

Parameters

Returns Promise<void>

setSigngenUserSigs

Parameters

Returns Promise<void>

Settings

On This Page