openid-client/docs/functions/ClientSecretBasic.md

Function: ClientSecretBasic()

💗 Help the project

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.

---

▸ ClientSecretBasic(clientSecret?): ClientAuth

client_secret_basic uses the HTTP Basic authentication scheme to send client_id and client_secret in an Authorization HTTP Header.

Parameters

Parameter	Type	Description
clientSecret?	string	Client Secret

Returns

ClientAuth

Examples

Usage with a Configuration obtained through discovery

let server!: URL
let clientId!: string
let clientSecret!: string
let clientMetadata!: Partial<client.ClientMetadata> | string | undefined

let config = await client.discovery(
  server,
  clientId,
  clientMetadata,
  client.ClientSecretBasic(clientSecret),
)

Usage with a Configuration instance

let server!: client.ServerMetadata
let clientId!: string
let clientSecret!: string
let clientMetadata!: Partial<client.ClientMetadata> | string | undefined

let config = new client.Configuration(
  server,
  clientId,
  clientMetadata,
  client.ClientSecretBasic(clientSecret),
)

See

• OAuth Token Endpoint Authentication Methods
• RFC 6749 - The OAuth 2.0 Authorization Framework
• OpenID Connect Core 1.0