Package version:

Class ClientCertificateCredential

Enables authentication to Microsoft Entra ID 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://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Implements

Constructors

constructor

Methods

getToken

Constructors

constructor

  • new ClientCertificateCredential(tenantId, clientId, certificatePath, options?): ClientCertificateCredential

  • Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.

    Parameters

    • tenantId: string

      The Microsoft Entra 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.

    • Optionaloptions: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

  • new ClientCertificateCredential(tenantId, clientId, configuration, options?): ClientCertificateCredential

  • Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.

    Parameters

    • tenantId: string

      The Microsoft Entra tenant (directory) ID.

    • clientId: string

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

    • configuration: ClientCertificatePEMCertificatePath

      Other parameters required, including the path of the certificate on the filesystem. If the type is ignored, we will throw the value of the path to a PEM certificate.

    • Optionaloptions: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

  • new ClientCertificateCredential(tenantId, clientId, configuration, options?): ClientCertificateCredential

  • Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.

    Parameters

    • tenantId: string

      The Microsoft Entra tenant (directory) ID.

    • clientId: string

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

    • configuration: ClientCertificatePEMCertificate

      Other parameters required, including the PEM-encoded certificate as a string. If the type is ignored, we will throw the value of the PEM-encoded certificate.

    • Optionaloptions: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

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