@azure/identity
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    Azure Identity client library for JavaScript

    The Azure Identity library provides Azure Active Directory (Azure AD) token authentication through a set of convenient TokenCredential implementations.

    For examples of various credentials, see the Azure Identity examples page.

    Key links:

    Getting started

    Migrate from v1 to v2 of @azure/identity

    If you're using v1 of @azure/identity, see the migration guide to update to v2.

    Currently supported environments

    • LTS versions of Node.js
      • Note: If your application runs on Node.js v8 or lower and you cannot upgrade your Node.js version to latest stable version, then pin your @azure/identity dependency to version 1.1.0.
    • Latest versions of Safari, Chrome, Edge, and Firefox.
      • Note: Among the different credentials exported in this library, InteractiveBrowserCredential is the only one that is supported in the browser.

    See our support policy for more details.

    Install the package

    Install Azure Identity with npm:

    npm install --save @azure/identity

    Prerequisites

    When to use @azure/identity

    The credential classes exposed by @azure/identity are focused on providing the most straightforward way to authenticate the Azure SDK clients locally, in your development environments, and in production. We aim for simplicity and reasonable support of the authentication protocols to cover most of the authentication scenarios possible on Azure. We're actively expanding to cover more scenarios. For a full list of the credentials offered, see the Credential Classes section.

    All credential types provided by @azure/identity are supported in Node.js. For browsers, InteractiveBrowserCredential is the credential type to be used for basic authentication scenarios.

    Most of the credential types offered by @azure/identity use the Microsoft Authentication Library for JavaScript (MSAL.js). Specifically, we use the v2 MSAL.js libraries, which use OAuth 2.0 Authorization Code Flow with PKCE and are OpenID-compliant. While @azure/identity focuses on simplicity, the MSAL.js libraries, such as @azure/msal-common, @azure/msal-node, and @azure/msal-browser, are designed to provide robust support for the authentication protocols that Azure supports.

    When to use something else

    The @azure/identity credential types are implementations of @azure/core-auth's TokenCredential class. In principle, any object with a getToken method that satisfies getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null> will work as a TokenCredential. This means developers can write their own credential types to support authentication cases not covered by @azure/identity. To learn more, see Custom Credentials.

    Though our credential types support many advanced cases, developers may want full control of the authentication protocol. For that use case, we recommend using Microsoft Authentication Library for JavaScript (MSAL.js) directly. You can read more through the following links:

    For advanced authentication workflows in the browser, we have a section where we showcase how to use the @azure/msal-browser library directly to authenticate Azure SDK clients.

    Authenticate the client in development environment

    While we recommend using managed identity or service principal authentication in your production application, it is typical for a developer to use their own account for authenticating calls to Azure services when debugging and executing code locally. There are several developer tools which can be used to perform this authentication in your development environment.

    Authenticating via the Azure CLI

    Applications using the AzureCliCredential, whether directly or via the DefaultAzureCredential, can use the Azure CLI account to authenticate calls in the application when running locally.

    To authenticate with the Azure CLI users can run the command az login. For users running on a system with a default web browser the Azure cli will launch the browser to authenticate the user.

    Azure CLI Account Sign In

    For systems without a default web browser, the az login command will use the device code authentication flow. The user can also force the Azure CLI to use the device code flow rather than launching a browser by specifying the --use-device-code argument.

    Azure CLI Account Device Code Sign In

    Authenticating via Azure PowerShell

    Applications using the AzurePowerShellCredential, whether directly or via the DefaultAzureCredential, can use the account connected to Azure PowerShell to authenticate calls in the application when running locally.

    To authenticate with Azure PowerShell users can run the Connect-AzAccount cmdlet. By default, ike the Azure CLI, Connect-AzAccount will launch the default web browser to authenticate a user account.

    Azure PowerShell Account Sign In

    If interactive authentication cannot be supported in the session, then the -UseDeviceAuthentication argument will force the cmdlet to use a device code authentication flow instead, similar to the corresponding option in the Azure CLI credential.

    Authenticate via Visual Studio Code

    Developers using Visual Studio Code can use the Azure Account extension to authenticate via the IDE. Apps using DefaultAzureCredential or VisualStudioCodeCredential can then use this account to authenticate calls in their app when running locally.

    To authenticate in Visual Studio Code, first ensure the Azure Account extension is installed. Once the extension is installed, open the Command Palette and run the Azure: Sign In command.

    Additionally, use the @azure/identity-vscode plugin package. This package provides the dependencies of VisualStudioCodeCredential and enables it. See Plugins.

    Authenticate the client in browsers

    To authenticate Azure SDKs within web browsers, we currently offer the InteractiveBrowserCredential, which can be set to use redirection or popups to complete the authentication flow. It is necessary to create an Azure App Registration in the portal for your web application first.

    Key concepts

    If this is your first time using @azure/identity or the Microsoft identity platform (Azure Active Directory), we recommend that you read Using @azure/identity with Microsoft Identity Platform first. This document will give you a deeper understanding of the platform and how to configure your Azure account correctly.

    Credentials

    A credential is a class which contains or can obtain the data needed for a service client to authenticate requests. Service clients across Azure SDK accept credentials when they are constructed, and service clients use those credentials to authenticate requests to the service.

    The Azure Identity library focuses on OAuth authentication with Azure Active directory, and it offers a variety of credential classes capable of acquiring an AAD token to authenticate service requests. All of the credential classes in this library are implementations of the TokenCredential abstract class, and any of them can be used by to construct service clients capable of authenticating with a TokenCredential.

    See Credential Classes.

    DefaultAzureCredential

    The DefaultAzureCredential is appropriate for most scenarios where the application is intended to ultimately be run in the Azure Cloud. This is because the DefaultAzureCredential combines credentials commonly used to authenticate when deployed with credentials used to authenticate in a development environment.

    Note: DefaultAzureCredential is intended to simplify getting started with the SDK by handling common scenarios with reasonable default behaviors. Developers who want more control or whose scenario isn't served by the default settings should use other credential types.

    If used from Node.js, the DefaultAzureCredential will attempt to authenticate via the following mechanisms in order:

    DefaultAzureCredential authentication flow

    • Environment - The DefaultAzureCredential will read account information specified via environment variables and use it to authenticate.
    • Managed Identity - If the application is deployed to an Azure host with Managed Identity enabled, the DefaultAzureCredential will authenticate with that account.
    • Visual Studio Code - If the developer has authenticated with the Visual Studio Code Azure Account extension, the DefaultAzureCredential will authenticate using that account.
    • Azure CLI - If the developer has authenticated an account via the Azure CLI az login command, the DefaultAzureCredential will authenticate with that account.
    • Azure PowerShell - If the developer has authenticated using the Azure PowerShell module Connect-AzAccount command, the DefaultAzureCredential will authenticate with that account.

    Plugins

    Azure Identity for JavaScript provides a plugin API that allows us to provide certain functionality through separate plugin packages. The @azure/identity package exports a top-level function (useIdentityPlugin) that can be used to enable a plugin. We provide two plugin packages:

    • @azure/identity-cache-persistence, which provides persistent token caching in Node.js using a native secure storage system provided by your operating system. This plugin allows cached access_token values to persist across sessions, meaning that an interactive login flow does not need to be repeated as long as a cached token is available.
    • @azure/identity-vscode, which provides the dependencies of VisualStudioCodeCredential and enables it. Without this plugin, the VisualStudioCodeCredential in this package will throw a CredentialUnavailableError. The plugin provides the underlying implementation of this credential, enabling it for use both on its own and as part of the DefaultAzureCredential described above.

    Environment Variables

    DefaultAzureCredential and EnvironmentCredential can be configured with environment variables. Each type of authentication requires values for specific variables:

    Service principal with secret

    variable name value
    AZURE_CLIENT_ID id of an Azure Active Directory application
    AZURE_TENANT_ID id of the application's Azure Active Directory tenant
    AZURE_CLIENT_SECRET one of the application's client secrets

    Service principal with certificate

    variable name value
    AZURE_CLIENT_ID id of an Azure Active Directory application
    AZURE_TENANT_ID id of the application's Azure Active Directory tenant
    AZURE_CLIENT_CERTIFICATE_PATH path to a PEM-encoded certificate file including private key (without password protection)

    Username and password

    variable name value
    AZURE_CLIENT_ID id of an Azure Active Directory application
    AZURE_USERNAME a username (usually an email address)
    AZURE_PASSWORD that user's password

    Configuration is attempted in the above order. For example, if values for a client secret and certificate are both present, the client secret will be used.

    Examples

    You can find more examples of using various credentials in Azure Identity Examples Page

    Authenticating with the DefaultAzureCredential

    This example demonstrates authenticating the KeyClient from the @azure/keyvault-keys client library using the DefaultAzureCredential.

    // The default credential first checks environment variables for configuration as described above.
    // If environment configuration is incomplete, it will try managed identity.
    
    // Azure Key Vault service to use
    const { KeyClient } = require("@azure/keyvault-keys");
    
    // Azure authentication library to access Azure Key Vault
    const { DefaultAzureCredential } = require("@azure/identity");
    
    // Azure SDK clients accept the credential as a parameter
    const credential = new DefaultAzureCredential();
    
    // Create authenticated client
    const client = new KeyClient(vaultUrl, credential);

    Specifying a user assigned managed identity with the DefaultAzureCredential

    A relatively common scenario involves authenticating using a user assigned managed identity for an Azure resource. Explore the example on Authenticating a user assigned managed identity with DefaultAzureCredential to see how this is made a relatively straightforward task that can be configured using environment variables or in code.

    Define a custom authentication flow with the ChainedTokenCredential

    While the DefaultAzureCredential is generally the quickest way to get started developing applications for Azure, more advanced users may want to customize the credentials considered when authenticating. The ChainedTokenCredential enables users to combine multiple credential instances to define a customized chain of credentials. This example demonstrates creating a ChainedTokenCredential which will attempt to authenticate using two differently configured instances of ClientSecretCredential, to then authenticate the KeyClient from the @azure/keyvault-keys:

    const { ClientSecretCredential, ChainedTokenCredential } = require("@azure/identity");
    
    // When an access token is requested, the chain will try each
    // credential in order, stopping when one provides a token
    const firstCredential = new ClientSecretCredential(tenantId, clientId, clientSecret);
    const secondCredential = new ClientSecretCredential(tenantId, anotherClientId, anotherSecret);
    const credentialChain = new ChainedTokenCredential(firstCredential, secondCredential);
    
    // The chain can be used anywhere a credential is required
    const { KeyClient } = require("@azure/keyvault-keys");
    const client = new KeyClient(vaultUrl, credentialChain);

    Managed Identity Support

    The Managed identity authentication is supported via either the DefaultAzureCredential or the ManagedIdentityCredential credential classes directly for the following Azure hosts:

    For examples of how to use managed identity for authentication please refer to the examples

    Cloud configuration

    Credentials default to authenticating to the Azure AD endpoint for Azure Public Cloud. To access resources in other clouds, such as Azure Government or a private cloud, configure credentials with the authorityHost argument in the constructor. The AzureAuthorityHosts interface defines authorities for well-known clouds. For the US Government cloud, you could instantiate a credential this way:

    import { AzureAuthorityHosts, ClientSecretCredential } from "@azure/identity";
    const credential = new ClientSecretCredential(
      "<YOUR_TENANT_ID>",
      "<YOUR_CLIENT_ID>",
      "<YOUR_CLIENT_SECRET>",
      {
        authorityHost: AzureAuthorityHosts.AzureGovernment
      }
    );

    Not all credentials require this configuration. Credentials that authenticate through a development tool, such as AzureCliCredential, use that tool's configuration. Similarly, VisualStudioCodeCredential accepts an authorityHost argument but defaults to the authorityHost matching Visual Studio Code's Azure: Cloud setting.

    Credential Classes

    Authenticating Azure Hosted Applications

    credential usage example
    DefaultAzureCredential Provides a simplified authentication experience to quickly start developing applications run in the Azure cloud. example
    ChainedTokenCredential Allows users to define custom authentication flows composing multiple credentials. example
    EnvironmentCredential Authenticates a service principal or user via credential information specified in environment variables. example
    ManagedIdentityCredential Authenticates the managed identity of an Azure resource. example

    Authenticating Service Principals

    credential usage example reference
    ClientSecretCredential Authenticates a service principal using a secret. example Service principal authentication
    ClientCertificateCredential Authenticates a service principal using a certificate. example Service principal authentication

    Authenticating Users

    credential usage example reference
    InteractiveBrowserCredential Interactively authenticates a user with the default system browser. Read more about how this happens here. example OAuth2 authentication code
    DeviceCodeCredential Interactively authenticates a user on devices with limited UI. example Device code authentication
    UsernamePasswordCredential Authenticates a user with a username and password. example Username + password authentication
    AuthorizationCodeCredential Authenticate a user with a previously obtained authorization code. example OAuth2 authentication code

    Authenticating via Development Tools

    credential usage example reference
    AzureCliCredential Authenticate in a development environment with the Azure CLI. example Azure CLI authentication
    AzurePowerShellCredential Authenticate in a development environment using Azure PowerShell. example Azure PowerShell authentication

    Troubleshooting

    Error Handling

    Credentials raise AuthenticationError when they fail to authenticate. This class has a message field which describes why authentication failed. An AggregateAuthenticationError will be raised by ChainedTokenCredential with an errors field containing an array of errors from each credential in the chain.

    Logging

    Enabling logging may help uncover useful information about failures. To see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. You can read this environment variable from the .env file by explicitly specifying a file path:

    require("dotenv").config({ path: ".env" });

    Alternatively, logging can be enabled at runtime by calling setLogLevel from the @azure/logger package:

    import { setLogLevel } from "@azure/logger";
    
    setLogLevel("info");

    For assistance with troubleshooting, see the troubleshooting guide.

    Next steps

    Read the documentation

    API documentation for this library can be found on our documentation site.

    Client library support

    Client and management libraries listed on the Azure SDK releases page that support Azure AD authentication accept credentials from this library. Learn more about using these libraries in their documentation, which is linked from the releases page.

    Known Issues

    Azure AD B2C support

    This library does not support the Azure AD B2C service.

    Provide Feedback

    If you encounter bugs or have suggestions, please open an issue.

    Contributing

    If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

    Impressions

    Install

    npm i @azure/identity

    DownloadsWeekly Downloads

    432,577

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    1.13 MB

    Total Files

    171

    Last publish

    Collaborators

    • azure-sdk