Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PushAuth

A PushAuth is a Cipherise authentication that is sent to a particular user's device. Upon receiving the authentication, the user must respond to it.

It is useful for when the user and their device are already known, but are required to re-authenticate (e.g. asserting their identity for a process of elevated permission).

To start the process, use Service.PushAuth. To deserialize an authentication, use Service.deserializePushAuth.

export
class

PushAuth

Hierarchy

Index

Properties

Protected assertionUrl

assertionUrl: string

The URL from which the authentication assertion can be retrieved.

Protected authChallenge

authChallenge: Buffer

The challenge posed to the device to solve.

Protected authLevel

authLevel: number

The authentication level for this authentication.

logId

logId: string

The log identifier for this enrolment.

Protected service

service: Service

The service this enrolment session originated from.

statusUrl

statusUrl: string

The URL for the short-poll status of the authentication, so that a client can query it.

Protected verifyAuthUrl

verifyAuthUrl: string | undefined

The URL used to notify the app that an authentication has completed.

Methods

authenticate

  • Waits for the user to authenticate, and then returns whether or not the authentication succeeded.

    memberof

    PushAuth

    Parameters

    • Optional payload: PayloadRequest

      Optional payload request. For more information, consult the documentation for PayloadRequest.

    Returns Promise<AuthenticationResult>

equals

  • Compares two authentications for equality.

    memberof

    PushAuth

    Parameters

    • b: PushAuth

      The authentication to compare against.

    Returns boolean

getState

getStatus

serialize

  • serialize(): Buffer
  • Serializes this authentication session to a buffer.

    memberof

    PushAuth

    Returns Buffer

Generated using TypeDoc