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: Enables authentication to Azure Active Directory using a PEM-encoded certificate that is assigned to an App Registration.

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

Hierarchy

  • ClientCertificateCredential

Implements

  • any
  • any

Index

Constructors

Methods

Constructors

constructor

  • 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: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

  • 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.

    • 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.

    • Optional options: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

  • 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.

    • configuration: ClientCertificatePEMCertificate

      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.

    • Optional options: ClientCertificateCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns ClientCertificateCredential

Methods

getToken

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

  • 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.

    Parameters

    • scopes: string | string[]

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

    • Default value options: GetTokenOptions = {}

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

    Returns Promise<AccessToken>

Generated using TypeDoc