Files
openid-client/docs/functions/dynamicClientRegistration.md
T

2.4 KiB

Function: dynamicClientRegistration()

💗 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.


â–¸ dynamicClientRegistration(server, metadata, clientAuthentication?, options?): Promise<Configuration>

Performs Authorization Server Metadata discovery and subsequently a Dynamic Client Registration at the discovered Authorization Server's ServerMetadata.registration_endpoint using the provided client metadata.

Note: This method also accepts a URL pointing directly to the Authorization Server's discovery document. Doing so is NOT RECOMMENDED as it disables the ServerMetadata.issuer validation.

Note: The method does not contain any logic to default the registered "token_endpoint_auth_method" based on ServerMetadata.token_endpoint_auth_methods_supported, nor does it default the "clientAuthentication" argument value beyond what its description says.

Parameters

Parameter Type Description
server URL URL representation of the Authorization Server's Issuer Identifier
metadata Partial<ClientMetadata> Client Metadata to register at the Authorization Server
clientAuthentication? ClientAuth Implementation of the Client's Authentication Method at the Authorization Server. Default is ClientSecretPost using the ClientMetadata.client_secret that the Authorization Server issued, None otherwise.
options? DynamicClientRegistrationRequestOptions

Returns

Promise<Configuration>