Class OidcClient

constructor

• new OidcClient(settings): OidcClient

• Parameters

  • settings: OidcClientSettings

  Returns OidcClient

• new OidcClient(settings, metadataService): OidcClient

• Parameters

  • settings: OidcClientSettingsStore
  • metadataService: MetadataService

  Returns OidcClient

ReadonlymetadataService

Readonlysettings

clearStaleState

• clearStaleState(): Promise<void>

• Returns Promise<void>

createSigninRequest

• createSigninRequest(__namedParameters): Promise<SigninRequest>

• Parameters

  • __namedParameters: CreateSigninRequestArgs

  Returns Promise<SigninRequest>

createSignoutRequest

• createSignoutRequest(__namedParameters?): Promise<SignoutRequest>

• Parameters

  • __namedParameters: CreateSignoutRequestArgs = {}

  Returns Promise<SignoutRequest>

getDpopProof

• getDpopProof(dpopStore, nonce?): Promise<string>

• Parameters

  • dpopStore: DPoPStore
  • Optionalnonce: string

  Returns Promise<string>

processResourceOwnerPasswordCredentials

• processResourceOwnerPasswordCredentials(__namedParameters): Promise<SigninResponse>

• Parameters

  • __namedParameters: ProcessResourceOwnerPasswordCredentialsArgs

  Returns Promise<SigninResponse>

processSigninResponse

• processSigninResponse(url, extraHeaders?): Promise<SigninResponse>

• Parameters

  • url: string
  • OptionalextraHeaders: Record<string, ExtraHeader>

  Returns Promise<SigninResponse>

processSignoutResponse

• processSignoutResponse(url): Promise<SignoutResponse>

• Parameters

  • url: string

  Returns Promise<SignoutResponse>

readSigninResponseState

• readSigninResponseState(url, removeState?): Promise<{
      response: SigninResponse;
      state: SigninState;
  }>

• Parameters

  • url: string
  • removeState: boolean = false

  Returns Promise<{
      response: SigninResponse;
      state: SigninState;
  }>

readSignoutResponseState

• readSignoutResponseState(url, removeState?): Promise<{
      response: SignoutResponse;
      state: undefined | State;
  }>

• Parameters

  • url: string
  • removeState: boolean = false

  Returns Promise<{
      response: SignoutResponse;
      state: undefined | State;
  }>

revokeToken

• revokeToken(token, type?): Promise<void>

• Parameters

  • token: string
  • Optionaltype: "access_token" | "refresh_token"

  Returns Promise<void>

useRefreshToken

• useRefreshToken(__namedParameters): Promise<SigninResponse>

• Parameters

  • __namedParameters: UseRefreshTokenArgs

  Returns Promise<SigninResponse>