43 lines
No EOL
2.2 KiB
TypeScript
43 lines
No EOL
2.2 KiB
TypeScript
import type { AccessToken, GetTokenOptions, TokenCredential } from "@azure/core-auth";
|
|
import type { UsernamePasswordCredentialOptions } from "./usernamePasswordCredentialOptions.js";
|
|
/**
|
|
* Enables authentication to Microsoft Entra ID 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.
|
|
*
|
|
* @deprecated UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.
|
|
*/
|
|
export declare class UsernamePasswordCredential implements TokenCredential {
|
|
private identityClient;
|
|
private tenantId;
|
|
private additionallyAllowedTenantIds;
|
|
private clientId;
|
|
private username;
|
|
private password;
|
|
/**
|
|
* Creates an instance of the UsernamePasswordCredential with the details
|
|
* needed to authenticate against Microsoft Entra ID with a username
|
|
* and password.
|
|
*
|
|
* @param tenantIdOrName - The Microsoft Entra tenant (directory) ID or name.
|
|
* @param clientId - The client (application) ID of an App Registration in the tenant.
|
|
* @param username - The user account's e-mail address (user name).
|
|
* @param password - The user account's account password
|
|
* @param options - Options for configuring the client which makes the authentication request.
|
|
*
|
|
*/
|
|
constructor(tenantIdOrName: string, clientId: string, username: string, password: string, options?: UsernamePasswordCredentialOptions);
|
|
/**
|
|
* Authenticates with Microsoft Entra ID 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 {@link AuthenticationError}
|
|
* containing failure details will be thrown.
|
|
*
|
|
* @param scopes - The list of scopes for which the token will have access.
|
|
* @param options - The options used to configure any requests this
|
|
* TokenCredential implementation might make.
|
|
*/
|
|
getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>;
|
|
}
|
|
//# sourceMappingURL=usernamePasswordCredential-browser.d.mts.map
|