Function: initiateBackchannelAuthentication()

May 28, 2025 · View on GitHub

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

▸ initiateBackchannelAuthentication(config, parameters): Promise<BackchannelAuthenticationResponse>

Initiates a Client-Initiated Backchannel Authentication Grant using parameters from the parameters argument.

Note

URL of the authorization server's backchannel authentication endpoint must be configured.

Parameters

Parameter	Type	Description
`config`	`Configuration`	-
`parameters`	`Record`<`string`, `string`> \| `URLSearchParams`	Authorization request parameters that will be sent to the backchannel authentication endpoint

Returns

Promise<BackchannelAuthenticationResponse>

Example

let config!: client.Configuration
let scope!: string
let login_hint!: string // one of login_hint, id_token_hint, or login_hint_token parameters must be provided in CIBA

let backchannelAuthenticationResponse =
  await client.initiateBackchannelAuthentication(config, {
    scope,
    login_hint,
  })

let { auth_req_id } = backchannelAuthenticationResponse