Package version:

Class ClientAssertionCredential

Authenticates a service principal with a JWT assertion.

Implements

Constructors

constructor

Methods

getToken

Constructors

constructor

  • new ClientAssertionCredential(tenantId, clientId, getAssertion, options?): ClientAssertionCredential

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

    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.

        • (): Promise<string>

        • Returns Promise<string>

    • options: ClientAssertionCredentialOptions = {}

      Options for configuring the client which makes the authentication request.

    Returns ClientAssertionCredential

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