Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientCertificateCredential

Package version

Enables authentication to Azure Active Directory using a PEM-encoded certificate that is assigned to an App Registration. More information on how to configure certificate authentication can be found here:

https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Hierarchy

  • ClientCertificateCredential

Implements

  • TokenCredential
  • TokenCredential

Index

Constructors

Methods

Constructors

constructor

  • Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with a certificate. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with a certificate.

    Parameters

    • tenantId: string

      The Azure Active Directory tenant (directory) ID.

    • clientId: string

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

    • certificatePath: string

      The path to a PEM-encoded public/private key certificate on the filesystem.

    • Optional options: TokenCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

Methods

getToken

  • getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>
  • Authenticates with Azure Active Directory and returns an access token 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