providers/ciam
default()
function default(options): OAuthConfig<Record<string, any>>
CIAM Provider
This provider is designed to integrate with a CIAM (Customer Identity and Access Management) service. It expects a set of endpoints to be configured for OAuth 2.0 authorization, token exchange, and user info retrieval.
Configuration
To use this provider, you must pass a configuration object with the following properties:
clientId
: The client ID provided by your CIAM service.clientSecret
: The client secret provided by your CIAM service.authorizationUrl
: The authorization endpoint of your CIAM service.tokenUrl
: The token endpoint of your CIAM service.userinfoUrl
: The userinfo endpoint of your CIAM service.issuer
: The issuer URL of your CIAM service.jwksEndpoint
: The JWKS endpoint of your CIAM service.
Additionally, you can override any of the default OAuthConfig
properties.
Parameters
Parameter | Type |
---|---|
options | Omit <OAuthUserConfig <Record <string , any >>, "checks" > & { authorizationUrl : string ; issuer : string ; jwksEndpoint : string ; tokenUrl : string ; userinfoUrl : string ; } |
Returns
OAuthConfig
<Record
<string
, any
>>