ClientSecretCredential class

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

Constructors

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

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

Methods

getToken(string | string[], GetTokenOptions)

Authenticates with Azure Active Directory and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure.

Constructor Details

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

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

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

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.

options
ClientSecretCredentialOptions

Options for configuring the client which makes the authentication request.

Method Details

getToken(string | string[], GetTokenOptions)

Authenticates with Azure Active Directory and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure.

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

Parameters

scopes

string | 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>