Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsernamePasswordCredential

Package version

Enables authentication to Azure Active Directory 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.

Hierarchy

  • UsernamePasswordCredential

Implements

  • TokenCredential

Index

Constructors

Methods

Constructors

constructor

  • Creates an instance of the UsernamePasswordCredential with the details needed to authenticate against Azure Active Directory with a username and password.

    Parameters

    • tenantIdOrName: string

      The Azure Active Directory tenant (directory) ID or name.

    • 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

    • Optional options: TokenCredentialOptions

      Options for configuring the client which makes the authentication request.

    Returns UsernamePasswordCredential

Methods

getToken

  • getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>
  • Authenticates with Azure Active Directory and returns an {@link AccessToken} if successful. If authentication cannot be performed at this time, this method may return null. If an error occurs during authentication, an AuthenticationError containing failure details will be thrown.

    Parameters

    • scopes: string | string[]

      The list of scopes for which the token will have access.

    • Optional options: GetTokenOptions

      The options used to configure any requests this TokenCredential implementation might make.

    Returns Promise<AccessToken | null>

Generated using TypeDoc