Class DeviceCodeCredential

Package version

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

Hierarchy

DeviceCodeCredential

Implements

TokenCredential
TokenCredential

Index

Constructors

constructor

Methods

getToken

Constructors

constructor

new DeviceCodeCredential(tenantId: string | "organizations", clientId: string, userPromptCallback: DeviceCodePromptCallback, options?: TokenCredentialOptions): DeviceCodeCredential

- Defined in credentials/deviceCodeCredential.ts:67
Creates an instance of DeviceCodeCredential with the details needed to initiate the device code authorization flow with Azure Active Directory.

Parameters
- tenantId: string | "organizations"
  
  The Azure Active Directory tenant (directory) ID or name. 'organizations' may be used when dealing with multi-tenant scenarios.
- clientId: string
  
  The client (application) ID of an App Registration in the tenant.
- userPromptCallback: DeviceCodePromptCallback
  
  A callback function that will be invoked to show DeviceCodeInfo to the user.
- Optional options: TokenCredentialOptions
  
  Options for configuring the client which makes the authentication request.
Returns DeviceCodeCredential

Methods

getToken

getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>

- Defined in credentials/deviceCodeCredential.ts:231
Authenticates with Azure Active Directory and returns an access token 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