ClientAssertionCredential class
Authenticates a service principal with a JWT assertion.
Constructors
| Client |
Creates an instance of the ClientAssertionCredential with the details
needed to authenticate against Microsoft Entra ID with a client
assertion provided by the developer through the |
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
ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)
Creates an instance of the ClientAssertionCredential with the details
needed to authenticate against Microsoft Entra ID with a client
assertion provided by the developer through the getAssertion function parameter.
new ClientAssertionCredential(tenantId: string, clientId: string, getAssertion: () => Promise<string>, options?: ClientAssertionCredentialOptions)Parameters
- tenantId
-
string
The Microsoft Entra tenant (directory) ID.
- clientId
-
string
The client (application) ID of an App Registration in the tenant.
- getAssertion
-
() => Promise<string>
A function that retrieves the assertion for the credential to use.
- options
- ClientAssertionCredentialOptions
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>