Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeviceCodeCredential

Package version

Enables authentication to Azure Active Directory using a device code that the user can enter into https://microsoft.com/devicelogin. Enables authentication to Azure Active Directory using a device code that the user can enter into https://microsoft.com/devicelogin.

Hierarchy

  • DeviceCodeCredential

Implements

  • any
  • any

Index

Constructors

Methods

Constructors

constructor

  • Only available in Node.js

    A message will be logged, giving users a code that they can use to authenticate once they go to https://microsoft.com/devicelogin

    Developers can configure how this message is shown by passing a custom userPromptCallback:

    const credential = new DeviceCodeCredential({
      tenantId: env.AZURE_TENANT_ID,
      clientId: env.AZURE_CLIENT_ID,
      userPromptCallback: (info) => {
        console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
      }
    });

    A message will be logged, giving users a code that they can use to authenticate once they go to https://microsoft.com/devicelogin

    Developers can configure how this message is shown by passing a custom userPromptCallback:

    const credential = new DeviceCodeCredential({
      tenantId: env.AZURE_TENANT_ID,
      clientId: env.AZURE_CLIENT_ID,
      userPromptCallback: (info) => {
        console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
      }
    });

    Returns DeviceCodeCredential

Methods

authenticate

  • authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<AuthenticationRecord | undefined>
  • Authenticates with Azure Active Directory and returns an access token if successful. If authentication fails, a CredentialUnavailableError will be thrown with the details of the failure.

    If the token can't be retrieved silently, this method will require user interaction to retrieve the token.

    Parameters

    • scopes: string | string[]

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

    • Default value options: GetTokenOptions = {}

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

    Returns Promise<AuthenticationRecord | undefined>

getToken

  • getToken(): Promise<AccessToken | null>
  • Authenticates with Azure Active Directory 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.

    Returns Promise<AccessToken | null>

Generated using TypeDoc