Package version:

Class UsernamePasswordCredential

Enables authentication to Microsoft Entra ID with a user's username and password. This credential requires a high degree of trust so you should only use it when other, more secure credential types can't be used.

Deprecated

UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.

Implements

Constructors

constructor

Methods

getToken

Constructors

constructor

  • new UsernamePasswordCredential(tenantId, clientId, username, password, options?): UsernamePasswordCredential

  • Creates an instance of the UsernamePasswordCredential with the details needed to authenticate against Microsoft Entra ID with a username and password.

    Parameters

    • tenantId: string

      The Microsoft Entra tenant (directory).

    • clientId: string

      The client (application) ID of an App Registration in the tenant.

    • username: string

      The user account's e-mail address (user name).

    • password: string

      The user account's account password

    • options: UsernamePasswordCredentialOptions = {}

      Options for configuring the client which makes the authentication request.

    Returns UsernamePasswordCredential

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.

    If the user provided the option disableAutomaticAuthentication, once the token can't be retrieved silently, this method won't attempt to request user interaction to retrieve the token.

    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