| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 |
- // Copyright (c) Microsoft Corporation. All rights reserved.
- // Licensed under the MIT License. See License.txt in the project root for license information.
- import { TokenCredentialsBase } from "./tokenCredentialsBase";
- import { Environment } from "@azure/ms-rest-azure-env";
- import { AuthConstants, TokenAudience } from "../util/authConstants";
- import { TokenResponse, TokenCache } from "adal-node";
- export class DeviceTokenCredentials extends TokenCredentialsBase {
- readonly username: string;
- /**
- * Creates a new DeviceTokenCredentials object that gets a new access token using userCodeInfo (contains user_code, device_code)
- * for authenticating user on device.
- *
- * When this credential is used, the script will provide a url and code. The user needs to copy the url and the code, paste it
- * in a browser and authenticate over there. If successful, the script will get the access token.
- *
- * @constructor
- * @param {string} [clientId] The active directory application client id.
- * @param {string} [domain] The domain or tenant id containing this application. Default value is "common"
- * @param {string} [username] The user name for account in the form: "user@example.com".
- * @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {Environment} [environment] The azure environment to authenticate with. Default environment is "Azure" popularly known as "Public Azure Cloud".
- * @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
- */
- public constructor(
- clientId?: string,
- domain?: string,
- username?: string,
- tokenAudience?: TokenAudience,
- environment?: Environment,
- tokenCache?: TokenCache) {
- if (!username) {
- username = "user@example.com";
- }
- if (!domain) {
- domain = AuthConstants.AAD_COMMON_TENANT;
- }
- if (!clientId) {
- clientId = AuthConstants.DEFAULT_ADAL_CLIENT_ID;
- }
- super(clientId, domain, tokenAudience, environment, tokenCache);
- this.username = username;
- }
- public getToken(): Promise<TokenResponse> {
- // For device auth, this is just getTokenFromCache.
- return this.getTokenFromCache(this.username);
- }
- }
|