@azure/identity 3.1.3 → 3.2.0-alpha.20230224.3

package/types/identity.d.ts

@@ -110,6 +110,18 @@ export declare interface AuthenticationRequiredErrorOptions {
     message?: string;
 }
 
+/**
+ * Provides options to configure how the Identity library
+ * does authority validation during authentication requests
+ * to Azure Active Directory.
+ */
+export declare interface AuthorityValidationOptions {
+    /**
+     * Setting this flag to `true` disables both authority validation and instance discovery.
+     */
+    disableInstanceDiscovery?: boolean;
+}
+
 /**
  * Enables authentication to Azure Active Directory using an authorization code
  * that was obtained through the authorization code flow, described in more detail
@@ -183,7 +195,7 @@ export declare class AuthorizationCodeCredential implements TokenCredential {
 /**
  * Options for the {@link AuthorizationCodeCredential}
  */
-export declare interface AuthorizationCodeCredentialOptions extends MultiTenantTokenCredentialOptions {
+export declare interface AuthorizationCodeCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
 }
 
 /**
@@ -308,10 +320,6 @@ export declare type BrowserLoginStyle = "redirect" | "popup";
  * until one of the getToken methods returns an access token.
  */
 export declare class ChainedTokenCredential implements TokenCredential {
-    /**
-     * The message to use when the chained token fails to get a token
-     */
-    protected UnavailableMessage: string;
     private _sources;
     /**
      * Creates an instance of ChainedTokenCredential using the given credentials.
@@ -376,7 +384,7 @@ export declare class ClientAssertionCredential implements TokenCredential {
 /**
  * Options for the {@link ClientAssertionCredential}
  */
-export declare interface ClientAssertionCredentialOptions extends MultiTenantTokenCredentialOptions {
+export declare interface ClientAssertionCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
 }
 
 /**
@@ -437,7 +445,7 @@ export declare class ClientCertificateCredential implements TokenCredential {
 /**
  * Optional parameters for the {@link ClientCertificateCredential} class.
  */
-export declare interface ClientCertificateCredentialOptions extends MultiTenantTokenCredentialOptions, CredentialPersistenceOptions {
+export declare interface ClientCertificateCredentialOptions extends MultiTenantTokenCredentialOptions, CredentialPersistenceOptions, AuthorityValidationOptions {
     /**
      * Option to include x5c header for SubjectName and Issuer name authorization.
      * Set this option to send base64 encoded public certificate in the client assertion header as an x5c claim
@@ -515,7 +523,7 @@ export declare class ClientSecretCredential implements TokenCredential {
 /**
  * Optional parameters for the {@link ClientSecretCredential} class.
  */
-export declare interface ClientSecretCredentialOptions extends MultiTenantTokenCredentialOptions, CredentialPersistenceOptions {
+export declare interface ClientSecretCredentialOptions extends MultiTenantTokenCredentialOptions, CredentialPersistenceOptions, AuthorityValidationOptions {
 }
 
 /**
@@ -583,7 +591,9 @@ export declare class DefaultAzureCredential extends ChainedTokenCredential {
      * The following credential types will be tried, in order:
      *
      * - {@link EnvironmentCredential}
+     * - {@link WorkloadIdentityCredential}
      * - {@link ManagedIdentityCredential}
+     * - {@link AzureDeveloperCliCredential}
      * - {@link AzureCliCredential}
      * - {@link AzurePowerShellCredential}
      *
@@ -602,7 +612,9 @@ export declare class DefaultAzureCredential extends ChainedTokenCredential {
      * The following credential types will be tried, in order:
      *
      * - {@link EnvironmentCredential}
+     * - {@link WorkloadIdentityCredential}
      * - {@link ManagedIdentityCredential}
+     * - {@link AzureDeveloperCliCredential}
      * - {@link AzureCliCredential}
      * - {@link AzurePowerShellCredential}
      *
@@ -621,7 +633,9 @@ export declare class DefaultAzureCredential extends ChainedTokenCredential {
      * The following credential types will be tried, in order:
      *
      * - {@link EnvironmentCredential}
+     * - {@link WorkloadIdentityCredential}
      * - {@link ManagedIdentityCredential}
+     * - {@link AzureDeveloperCliCredential}
      * - {@link AzureCliCredential}
      * - {@link AzurePowerShellCredential}
      *
@@ -648,7 +662,7 @@ export declare interface DefaultAzureCredentialClientIdOptions extends DefaultAz
 /**
  * Provides options to configure the {@link DefaultAzureCredential} class.
  */
-export declare interface DefaultAzureCredentialOptions extends MultiTenantTokenCredentialOptions {
+export declare interface DefaultAzureCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
     /**
      * Optionally pass in a Tenant ID to be used as part of the credential.
      * By default it may use a generic tenant ID depending on the underlying credential.
@@ -841,7 +855,7 @@ export declare class EnvironmentCredential implements TokenCredential {
  * Enables authentication to Azure Active Directory depending on the available environment variables.
  * Defines options for the EnvironmentCredential class.
  */
-export declare interface EnvironmentCredentialOptions extends MultiTenantTokenCredentialOptions {
+export declare interface EnvironmentCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
 }
 
 /**
@@ -978,7 +992,7 @@ export declare interface InteractiveBrowserCredentialInBrowserOptions extends In
 /**
  * Defines the common options for the InteractiveBrowserCredential class.
  */
-export declare interface InteractiveBrowserCredentialNodeOptions extends InteractiveCredentialOptions, CredentialPersistenceOptions {
+export declare interface InteractiveBrowserCredentialNodeOptions extends InteractiveCredentialOptions, CredentialPersistenceOptions, AuthorityValidationOptions {
     /**
      * Gets the redirect URI of the application. This should be same as the value
      * in the application registration portal.  Defaults to `window.location.href`.
@@ -1002,7 +1016,7 @@ export declare interface InteractiveBrowserCredentialNodeOptions extends Interac
 /**
  * Common constructor options for the Identity credentials that requires user interaction.
  */
-export declare interface InteractiveCredentialOptions extends MultiTenantTokenCredentialOptions {
+export declare interface InteractiveCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
     /**
      * Result of a previous authentication that can be used to retrieve the cached credentials of each individual account.
      * This is necessary to provide in case the application wants to work with more than one account per
@@ -1212,7 +1226,7 @@ export declare interface OnBehalfOfCredentialCertificateOptions {
 /**
  * Optional parameters for the {@link OnBehalfOfCredential} class.
  */
-export declare type OnBehalfOfCredentialOptions = (OnBehalfOfCredentialSecretOptions | OnBehalfOfCredentialCertificateOptions) & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions;
+export declare type OnBehalfOfCredentialOptions = (OnBehalfOfCredentialSecretOptions | OnBehalfOfCredentialCertificateOptions) & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions & AuthorityValidationOptions;
 
 /**
  * Defines the parameters to authenticate the {@link OnBehalfOfCredential} with a secret.
@@ -1428,4 +1442,50 @@ export declare interface VisualStudioCodeCredentialOptions extends MultiTenantTo
     tenantId?: string;
 }
 
+/**
+ * WorkloadIdentityCredential supports Azure workload identity authentication on Kubernetes.
+ * Refer to <a href="https://learn.microsoft.com/azure/aks/workload-identity-overview">Azure Active Directory Workload Identity</a>
+ * for more information.
+ */
+export declare class WorkloadIdentityCredential implements TokenCredential {
+    private client;
+    private federatedTokenFilePath;
+    private azureFederatedTokenFileContent;
+    private cacheDate;
+    /**
+     * WorkloadIdentityCredential supports Azure workload identity on Kubernetes.
+     *
+     * @param options - The identity client options to use for authentication.
+     */
+    constructor(options?: WorkloadIdentityCredentialOptions);
+    /**
+     * Authenticates with Azure Active Directory and returns an access token if successful.
+     * If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
+     *
+     * @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>;
+    private readFileContents;
+}
+
+/**
+ * Options for the {@link WorkloadIdentityCredential}
+ */
+export declare interface WorkloadIdentityCredentialOptions extends MultiTenantTokenCredentialOptions, AuthorityValidationOptions {
+    /**
+     * ID of the application's Azure Active Directory tenant. Also called its directory ID.
+     */
+    tenantId?: string;
+    /**
+     * The client ID of an Azure AD app registration.
+     */
+    clientId?: string;
+    /**
+     * The path to a file containing a Kubernetes service account token that authenticates the identity.
+     */
+    federatedTokenFilePath?: string;
+}
+
 export { }