Package version:

Class ClientSecretCredential

Enables authentication to Microsoft Entra ID using a client secret that was generated for an App Registration. More information on how to configure a client secret can be found here:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Implements

Constructors

constructor

Methods

getToken

Constructors

constructor

  • new ClientSecretCredential(tenantId, clientId, clientSecret, options?): ClientSecretCredential

  • Creates an instance of the ClientSecretCredential with the details needed to authenticate against Microsoft Entra ID with a client secret.

    Parameters

    • tenantId: string

      The Microsoft Entra tenant (directory) ID.

    • clientId: string

      The client (application) ID of an App Registration in the tenant.

    • clientSecret: string

      A client secret that was generated for the App Registration.

    • options: ClientSecretCredentialOptions = {}

      Options for configuring the client which makes the authentication request.

    Returns ClientSecretCredential

Methods

getToken

  • getToken(scopes, options?): Promise<AccessToken>

  • Authenticates with Microsoft Entra ID and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure.

    Parameters

    • scopes: string | {}

      The list of scopes for which the token will have access.

    • options: GetTokenOptions = {}

      The options used to configure any requests this TokenCredential implementation might make.

    Returns Promise<AccessToken>

Settings

Member Visibility