import type { CredentialPersistenceOptions } from "./credentialPersistenceOptions.js";
|
import type { InteractiveCredentialOptions } from "./interactiveCredentialOptions.js";
|
/**
|
* Provides the user code and verification URI where the code must be
|
* entered. Also provides a message to display to the user which
|
* contains an instruction with these details.
|
*/
|
export interface DeviceCodeInfo {
|
/**
|
* The device code that the user must enter into the verification page.
|
*/
|
userCode: string;
|
/**
|
* The verification URI to which the user must navigate to enter the device
|
* code.
|
*/
|
verificationUri: string;
|
/**
|
* A message that may be shown to the user to instruct them on how to enter
|
* the device code in the page specified by the verification URI.
|
*/
|
message: string;
|
}
|
/**
|
* Defines the signature of a callback which will be passed to
|
* DeviceCodeCredential for the purpose of displaying authentication
|
* details to the user.
|
*/
|
export type DeviceCodePromptCallback = (deviceCodeInfo: DeviceCodeInfo) => void;
|
/**
|
* Defines options for the InteractiveBrowserCredential class for Node.js.
|
*/
|
export interface DeviceCodeCredentialOptions extends InteractiveCredentialOptions, CredentialPersistenceOptions {
|
/**
|
* The Microsoft Entra tenant (directory) ID.
|
*/
|
tenantId?: string;
|
/**
|
* Client ID of the Microsoft Entra application that users will sign into.
|
* It is recommended that developers register their applications and assign appropriate roles.
|
* For more information, visit https://aka.ms/identity/AppRegistrationAndRoleAssignment.
|
* If not specified, users will authenticate to an Azure development application,
|
* which is not recommended for production scenarios.
|
*/
|
clientId?: string;
|
/**
|
* A callback function that will be invoked to show {@link DeviceCodeInfo} to the user.
|
* If left unassigned, we will automatically log the device code information
|
* and the authentication instructions in the console.
|
*/
|
userPromptCallback?: DeviceCodePromptCallback;
|
}
|
//# sourceMappingURL=deviceCodeCredentialOptions.d.ts.map
|
