ClientCertificateCredential class
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:
Constructors
Client |
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate. |
Client |
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate. |
Client |
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate. |
Methods
get |
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. |
Constructor Details
ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)
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.
Options for configuring the client which makes the authentication request.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)
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.
Options for configuring the client which makes the authentication request.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)
Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Microsoft Entra ID with a certificate.
new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)
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.
Options for configuring the client which makes the authentication request.
Method Details
getToken(string | string[], GetTokenOptions)
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.
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>