@azure/ms-rest-nodeauth
Version:
Azure Authentication library in node.js with type definitions.
27 lines • 1.89 kB
TypeScript
import { ApplicationTokenCredentialsBase } from "./applicationTokenCredentialsBase";
import { Environment } from "@azure/ms-rest-azure-env";
import { TokenAudience } from "../util/authConstants";
import { TokenResponse, TokenCache } from "adal-node";
export declare class ApplicationTokenCredentials extends ApplicationTokenCredentialsBase {
readonly secret: string;
/**
* Creates a new ApplicationTokenCredentials object.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for detailed instructions on creating an Azure Active Directory application.
*
* @param clientId - The active directory application client id.
* @param domain - The domain or tenant id containing this application.
* @param secret - The authentication secret for the application.
* @param 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).
* @param environment - The azure environment to authenticate with.
* @param tokenCache - The token cache. Default value is the MemoryCache object from adal.
*/
constructor(clientId: string, domain: string, secret: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache);
/**
* Tries to get the token from cache initially. If that is unsuccessfull then it tries to get the token from ADAL.
* @returns A promise that resolves to TokenResponse and rejects with an Error.
*/
getToken(): Promise<TokenResponse>;
}
//# sourceMappingURL=applicationTokenCredentials.d.ts.map