Options
All
  • Public
  • Public/Protected
  • All
Menu

This class is to be used to acquire tokens for public client applications (desktop, mobile). Public client applications are not trusted to safely store application secrets, and therefore can only request tokens in the name of an user.

Hierarchy

Implements

Index

Constructors

constructor

  • Important attributes in the Configuration object for auth are:

    • clientID: the application ID of your application. You can obtain one by registering your application with our Application registration portal.
    • authority: the authority URL for your application.

    AAD authorities are of the form https://login.microsoftonline.com/\{Enter_the_Tenant_Info_Here\}.

    • If your application supports Accounts in one organizational directory, replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant name (for example, contoso.microsoft.com).
    • If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations.
    • If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common.
    • To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers.

    Azure B2C authorities are of the form https://{instance}/{tenant}/{policy}. Each policy is considered its own authority. You will have to set the all of the knownAuthorities at the time of the client application construction.

    ADFS authorities are of the form https://{instance}/adfs.

    Parameters

    Returns PublicClientApplication

Methods

acquireTokenByCode

acquireTokenByDeviceCode

  • Acquires a token from the authority using OAuth2.0 device code flow. This flow is designed for devices that do not have access to a browser or have input constraints. The authorization server issues a DeviceCode object with a verification code, an end-user code, and the end-user verification URI. The DeviceCode object is provided through a callback, and the end-user should be instructed to use another device to navigate to the verification URI to input credentials. Since the client cannot receive incoming requests, it polls the authorization server repeatedly until the end-user completes input of credentials.

    Parameters

    Returns Promise<AuthenticationResult>

acquireTokenByRefreshToken

acquireTokenByUsernamePassword

acquireTokenSilent

getAuthCodeUrl

  • Creates the URL of the authorization request, letting the user input credentials and consent to the application. The URL targets the /authorize endpoint of the authority configured in the application object.

    Once the user inputs their credentials and consents, the authority will send a response to the redirect URI sent in the request and should contain an authorization code, which can then be used to acquire tokens via acquireTokenByCode(AuthorizationCodeRequest).

    Parameters

    Returns Promise<string>

getLogger

getTokenCache

setLogger

  • setLogger(logger: Logger): void

Generated using TypeDoc