Class OidcTokenRefresherExperimental

constructor

• new OidcTokenRefresher(
      issuer: string,
      clientId: string,
      redirectUri: string,
      deviceId: string,
      idTokenClaims: IdTokenClaims,
  ): OidcTokenRefresher
• Experimental

  Parameters

  • issuer: string

    The OIDC issuer as returned by the /auth_issuer API
  • clientId: string

    id of this client as registered with the OP
  • redirectUri: string

    redirectUri as registered with OP
  • deviceId: string

    Device ID of current session
  • idTokenClaims: IdTokenClaims

    idTokenClaims as returned from authorization grant used to validate tokens

  Returns OidcTokenRefresher

Readonly ExperimentaloidcClientReady

doRefreshAccessToken

• doRefreshAccessToken(refreshToken: string): Promise<AccessTokens>
• Experimental

  Attempt token refresh using given refresh token

  Parameters

  • refreshToken: string

    refresh token to use in request with token issuer

  Returns Promise<AccessTokens>

  tokens - Promise that resolves with new access and refresh tokens

  Throws

  when token refresh fails

persistTokens

• persistTokens(
      tokens: { accessToken: string; refreshToken?: string },
  ): Promise<void>
• Experimental

  Persist the new tokens, called after tokens are successfully refreshed.

  This function is intended to be overriden by the consumer when persistence is necessary.

  Parameters

  • tokens: { accessToken: string; refreshToken?: string }

    • accessToken: string

      new access token

    • OptionalrefreshToken?: string

      OPTIONAL new refresh token

  Returns Promise<void>