Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientSecretCredential

Package version

Enables authentication to Azure Active Directory 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://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Hierarchy

  • ClientSecretCredential

Implements

  • TokenCredential

Index

Constructors

Methods

Constructors

constructor

  • Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a client secret.

    Parameters

    • tenantId: string

      The Azure Active Directory 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.

    • Optional options: TokenCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientSecretCredential

Methods

getToken

  • getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>

  • Authenticates with Azure Active Directory and returns an {@link AccessToken} if successful. If authentication cannot be performed at this time, this method may return null. If an error occurs during authentication, an AuthenticationError containing failure details will be thrown.

    Parameters

    • scopes: string | string[]

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

    • Optional options: GetTokenOptions

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

    Returns Promise<AccessToken | null>

Generated using TypeDoc