@azure/identity 3.3.2-alpha.20231013.2 → 3.3.2-alpha.20231016.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of @azure/identity might be problematic. Click here for more details.
- package/README.md +14 -14
- package/dist/index.js +45 -45
- package/dist/index.js.map +1 -1
- package/dist-esm/src/credentials/authorityValidationOptions.js.map +1 -1
- package/dist-esm/src/credentials/authorizationCodeCredential.js +4 -4
- package/dist-esm/src/credentials/authorizationCodeCredential.js.map +1 -1
- package/dist-esm/src/credentials/azureCliCredential.js +1 -1
- package/dist-esm/src/credentials/azureCliCredential.js.map +1 -1
- package/dist-esm/src/credentials/azureDeveloperCliCredential.js +4 -4
- package/dist-esm/src/credentials/azureDeveloperCliCredential.js.map +1 -1
- package/dist-esm/src/credentials/azurePowerShellCredential.js +1 -1
- package/dist-esm/src/credentials/azurePowerShellCredential.js.map +1 -1
- package/dist-esm/src/credentials/clientAssertionCredential.js +3 -3
- package/dist-esm/src/credentials/clientAssertionCredential.js.map +1 -1
- package/dist-esm/src/credentials/clientCertificateCredential.browser.js +1 -1
- package/dist-esm/src/credentials/clientCertificateCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/clientCertificateCredential.js +2 -2
- package/dist-esm/src/credentials/clientCertificateCredential.js.map +1 -1
- package/dist-esm/src/credentials/clientSecretCredential.browser.js +4 -4
- package/dist-esm/src/credentials/clientSecretCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/clientSecretCredential.js +5 -5
- package/dist-esm/src/credentials/clientSecretCredential.js.map +1 -1
- package/dist-esm/src/credentials/deviceCodeCredential.browser.js +1 -1
- package/dist-esm/src/credentials/deviceCodeCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/deviceCodeCredential.js +4 -4
- package/dist-esm/src/credentials/deviceCodeCredential.js.map +1 -1
- package/dist-esm/src/credentials/deviceCodeCredentialOptions.js.map +1 -1
- package/dist-esm/src/credentials/environmentCredential.browser.js +1 -1
- package/dist-esm/src/credentials/environmentCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/environmentCredential.js +3 -3
- package/dist-esm/src/credentials/environmentCredential.js.map +1 -1
- package/dist-esm/src/credentials/environmentCredentialOptions.js.map +1 -1
- package/dist-esm/src/credentials/interactiveBrowserCredential.browser.js +5 -5
- package/dist-esm/src/credentials/interactiveBrowserCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/interactiveBrowserCredential.js +6 -6
- package/dist-esm/src/credentials/interactiveBrowserCredential.js.map +1 -1
- package/dist-esm/src/credentials/interactiveBrowserCredentialOptions.js.map +1 -1
- package/dist-esm/src/credentials/managedIdentityCredential/index.js +1 -1
- package/dist-esm/src/credentials/managedIdentityCredential/index.js.map +1 -1
- package/dist-esm/src/credentials/onBehalfOfCredential.browser.js +1 -1
- package/dist-esm/src/credentials/onBehalfOfCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/onBehalfOfCredential.js +2 -2
- package/dist-esm/src/credentials/onBehalfOfCredential.js.map +1 -1
- package/dist-esm/src/credentials/onBehalfOfCredentialOptions.js.map +1 -1
- package/dist-esm/src/credentials/usernamePasswordCredential.browser.js +4 -4
- package/dist-esm/src/credentials/usernamePasswordCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/usernamePasswordCredential.js +4 -4
- package/dist-esm/src/credentials/usernamePasswordCredential.js.map +1 -1
- package/dist-esm/src/credentials/workloadIdentityCredential.browser.js +2 -2
- package/dist-esm/src/credentials/workloadIdentityCredential.browser.js.map +1 -1
- package/dist-esm/src/credentials/workloadIdentityCredential.js +5 -5
- package/dist-esm/src/credentials/workloadIdentityCredential.js.map +1 -1
- package/dist-esm/src/credentials/workloadIdentityCredentialOptions.js.map +1 -1
- package/dist-esm/src/tokenCredentialOptions.js.map +1 -1
- package/package.json +1 -1
- package/types/identity.d.ts +67 -67
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Azure Identity client library for JavaScript
|
|
2
2
|
|
|
3
|
-
The Azure Identity library provides [
|
|
3
|
+
The Azure Identity library provides [Microsoft Entra ID](https://learn.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) ([formerly Azure Active Directory](https://learn.microsoft.com/azure/active-directory/fundamentals/new-name)) token authentication through a set of convenient [TokenCredential](https://learn.microsoft.com/javascript/api/@azure/core-auth/tokencredential) implementations.
|
|
4
4
|
|
|
5
5
|
For examples of various credentials, see the [Azure Identity examples page](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md).
|
|
6
6
|
|
|
@@ -9,7 +9,7 @@ Key links:
|
|
|
9
9
|
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity)
|
|
10
10
|
- [Package (npm)](https://www.npmjs.com/package/@azure/identity)
|
|
11
11
|
- [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/identity)
|
|
12
|
-
- [
|
|
12
|
+
- [Microsoft Entra ID documentation](https://azure.microsoft.com/services/active-directory/)
|
|
13
13
|
- [Samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2)
|
|
14
14
|
|
|
15
15
|
## Getting started
|
|
@@ -110,13 +110,13 @@ To authenticate Azure SDK clients within web browsers, we offer the `Interactive
|
|
|
110
110
|
|
|
111
111
|
## Key concepts
|
|
112
112
|
|
|
113
|
-
If this is your first time using `@azure/identity` or
|
|
113
|
+
If this is your first time using `@azure/identity` or Microsoft Entra ID, read [Using `@azure/identity` with Microsoft Entra ID](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/using-azure-identity.md) first. This document provides a deeper understanding of the platform and how to configure your Azure account correctly.
|
|
114
114
|
|
|
115
115
|
### Credentials
|
|
116
116
|
|
|
117
117
|
A credential is a class which contains or can obtain the data needed for a service client to authenticate requests. Service clients across the Azure SDK accept credentials when they're constructed. Service clients use those credentials to authenticate requests to the service.
|
|
118
118
|
|
|
119
|
-
The Azure Identity library focuses on OAuth authentication with
|
|
119
|
+
The Azure Identity library focuses on OAuth authentication with Microsoft Entra ID, and it offers a variety of credential classes capable of acquiring a Microsoft Entra token to authenticate service requests. All of the credential classes in this library are implementations of the [TokenCredential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-auth/src/tokenCredential.ts) abstract class, and any of them can be used by to construct service clients capable of authenticating with a TokenCredential.
|
|
120
120
|
|
|
121
121
|
See [Credential Classes](#credential-classes).
|
|
122
122
|
|
|
@@ -217,7 +217,7 @@ For examples of how to use managed identity for authentication, see [the example
|
|
|
217
217
|
|
|
218
218
|
## Cloud configuration
|
|
219
219
|
|
|
220
|
-
Credentials default to authenticating to the
|
|
220
|
+
Credentials default to authenticating to the Microsoft Entra endpoint for Azure Public Cloud. To access resources in other clouds, such as Azure Government or a private cloud, configure credentials with the `authorityHost` argument in the constructor. The `AzureAuthorityHosts` interface defines authorities for well-known clouds. For the US Government cloud, you could instantiate a credential this way:
|
|
221
221
|
|
|
222
222
|
```typescript
|
|
223
223
|
import { AzureAuthorityHosts, ClientSecretCredential } from "@azure/identity";
|
|
@@ -243,7 +243,7 @@ Not all credentials require this configuration. Credentials that authenticate th
|
|
|
243
243
|
| [`ChainedTokenCredential`](https://learn.microsoft.com/javascript/api/@azure/identity/chainedtokencredential?view=azure-node-latest) | Allows users to define custom authentication flows composing multiple credentials. | [example](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#chaining-credentials) |
|
|
244
244
|
| [`EnvironmentCredential`](https://learn.microsoft.com/javascript/api/@azure/identity/environmentcredential?view=azure-node-latest) | Authenticates a service principal or user via credential information specified in environment variables. | [example](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-a-service-principal-with-environment-credentials) |
|
|
245
245
|
| [`ManagedIdentityCredential`](https://learn.microsoft.com/javascript/api/@azure/identity/managedidentitycredential?view=azure-node-latest) | Authenticates the managed identity of an Azure resource. | [example](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-in-azure-with-managed-identity) |
|
|
246
|
-
| [`WorkloadIdentityCredential`](https://learn.microsoft.com/javascript/api/@azure/identity/workloadidentitycredential?view=azure-node-latest)| Supports [
|
|
246
|
+
| [`WorkloadIdentityCredential`](https://learn.microsoft.com/javascript/api/@azure/identity/workloadidentitycredential?view=azure-node-latest)| Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes. | |
|
|
247
247
|
|
|
248
248
|
### Authenticate service principals
|
|
249
249
|
|
|
@@ -280,16 +280,16 @@ Not all credentials require this configuration. Credentials that authenticate th
|
|
|
280
280
|
|
|
281
281
|
| Variable name | Value |
|
|
282
282
|
| --------------------- | --------------------------------------- |
|
|
283
|
-
| `AZURE_CLIENT_ID` | ID of
|
|
284
|
-
| `AZURE_TENANT_ID` | ID of the application's
|
|
283
|
+
| `AZURE_CLIENT_ID` | ID of a Microsoft Entra application |
|
|
284
|
+
| `AZURE_TENANT_ID` | ID of the application's Microsoft Entra tenant |
|
|
285
285
|
| `AZURE_CLIENT_SECRET` | one of the application's client secrets |
|
|
286
286
|
|
|
287
287
|
#### Service principal with certificate
|
|
288
288
|
|
|
289
289
|
| Variable name | Value |
|
|
290
290
|
| ----------------------------------- | ------------------------------------------------------------ |
|
|
291
|
-
| `AZURE_CLIENT_ID` | ID of
|
|
292
|
-
| `AZURE_TENANT_ID` | ID of the application's
|
|
291
|
+
| `AZURE_CLIENT_ID` | ID of a Microsoft Entra application |
|
|
292
|
+
| `AZURE_TENANT_ID` | ID of the application's Microsoft Entra tenant |
|
|
293
293
|
| `AZURE_CLIENT_CERTIFICATE_PATH` | path to a PEM-encoded certificate file including private key |
|
|
294
294
|
| `AZURE_CLIENT_CERTIFICATE_PASSWORD` | password of the certificate file, if any |
|
|
295
295
|
|
|
@@ -297,8 +297,8 @@ Not all credentials require this configuration. Credentials that authenticate th
|
|
|
297
297
|
|
|
298
298
|
| Variable name | Value |
|
|
299
299
|
| ----------------- | --------------------------------------- |
|
|
300
|
-
| `AZURE_CLIENT_ID` | ID of
|
|
301
|
-
| `AZURE_TENANT_ID` | ID of the application's
|
|
300
|
+
| `AZURE_CLIENT_ID` | ID of a Microsoft Entra application |
|
|
301
|
+
| `AZURE_TENANT_ID` | ID of the application's Microsoft Entra tenant |
|
|
302
302
|
| `AZURE_USERNAME` | a username (usually an email address) |
|
|
303
303
|
| `AZURE_PASSWORD` | that user's password |
|
|
304
304
|
|
|
@@ -314,7 +314,7 @@ Token caching is a feature provided by the Azure Identity library that allows ap
|
|
|
314
314
|
|
|
315
315
|
- Cache tokens in memory (default) and on disk (opt-in).
|
|
316
316
|
- Improve resilience and performance.
|
|
317
|
-
- Reduce the number of requests made to
|
|
317
|
+
- Reduce the number of requests made to Microsoft Entra ID to obtain access tokens.
|
|
318
318
|
|
|
319
319
|
The Azure Identity library offers both in-memory and persistent disk caching. For more details, see the [token caching documentation](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/TOKEN_CACHING.md).
|
|
320
320
|
|
|
@@ -330,7 +330,7 @@ API documentation for this library can be found on our [documentation site](http
|
|
|
330
330
|
|
|
331
331
|
### Client library support
|
|
332
332
|
|
|
333
|
-
Client and management libraries listed on the [Azure SDK releases page](https://azure.github.io/azure-sdk/releases/latest/js.html) that support
|
|
333
|
+
Client and management libraries listed on the [Azure SDK releases page](https://azure.github.io/azure-sdk/releases/latest/js.html) that support Microsoft Entra authentication accept credentials from this library. Learn more about using these libraries in their documentation, which is linked from the releases page.
|
|
334
334
|
|
|
335
335
|
### Known issues
|
|
336
336
|
|
package/dist/index.js
CHANGED
|
@@ -1958,10 +1958,10 @@ const logger$h = credentialLogger("ClientAssertionCredential");
|
|
|
1958
1958
|
class ClientAssertionCredential {
|
|
1959
1959
|
/**
|
|
1960
1960
|
* Creates an instance of the ClientAssertionCredential with the details
|
|
1961
|
-
* needed to authenticate against
|
|
1961
|
+
* needed to authenticate against Microsoft Entra ID with a client
|
|
1962
1962
|
* assertion provided by the developer through the `getAssertion` function parameter.
|
|
1963
1963
|
*
|
|
1964
|
-
* @param tenantId - The
|
|
1964
|
+
* @param tenantId - The Microsoft Entra tenant (directory) ID.
|
|
1965
1965
|
* @param clientId - The client (application) ID of an App Registration in the tenant.
|
|
1966
1966
|
* @param getAssertion - A function that retrieves the assertion for the credential to use.
|
|
1967
1967
|
* @param options - Options for configuring the client which makes the authentication request.
|
|
@@ -1977,7 +1977,7 @@ class ClientAssertionCredential {
|
|
|
1977
1977
|
this.msalFlow = new MsalClientAssertion(Object.assign(Object.assign({}, options), { logger: logger$h, clientId: this.clientId, tenantId: this.tenantId, tokenCredentialOptions: this.options, getAssertion }));
|
|
1978
1978
|
}
|
|
1979
1979
|
/**
|
|
1980
|
-
* Authenticates with
|
|
1980
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
1981
1981
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
1982
1982
|
*
|
|
1983
1983
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -2018,14 +2018,14 @@ const logger$g = credentialLogger(credentialName$3);
|
|
|
2018
2018
|
* Identity authentication, you can avoid the need to manage and rotate service principals or managed identities for
|
|
2019
2019
|
* each application on each VM. Additionally, because SACs are created automatically and managed by Azure, you don't
|
|
2020
2020
|
* need to worry about storing and securing sensitive credentials themselves.
|
|
2021
|
-
* The WorkloadIdentityCredential supports
|
|
2021
|
+
* The WorkloadIdentityCredential supports Microsoft Entra Workload ID authentication on Azure Kubernetes and acquires
|
|
2022
2022
|
* a token using the SACs available in the Azure Kubernetes environment.
|
|
2023
|
-
* Refer to <a href="https://learn.microsoft.com/azure/aks/workload-identity-overview">
|
|
2024
|
-
* Workload
|
|
2023
|
+
* Refer to <a href="https://learn.microsoft.com/azure/aks/workload-identity-overview">Microsoft Entra
|
|
2024
|
+
* Workload ID</a> for more information.
|
|
2025
2025
|
*/
|
|
2026
2026
|
class WorkloadIdentityCredential {
|
|
2027
2027
|
/**
|
|
2028
|
-
* WorkloadIdentityCredential supports
|
|
2028
|
+
* WorkloadIdentityCredential supports Microsoft Entra Workload ID on Kubernetes.
|
|
2029
2029
|
*
|
|
2030
2030
|
* @param options - The identity client options to use for authentication.
|
|
2031
2031
|
*/
|
|
@@ -2049,7 +2049,7 @@ class WorkloadIdentityCredential {
|
|
|
2049
2049
|
}
|
|
2050
2050
|
}
|
|
2051
2051
|
/**
|
|
2052
|
-
* Authenticates with
|
|
2052
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
2053
2053
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
2054
2054
|
*
|
|
2055
2055
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -2388,7 +2388,7 @@ class ManagedIdentityCredential {
|
|
|
2388
2388
|
}
|
|
2389
2389
|
}
|
|
2390
2390
|
/**
|
|
2391
|
-
* Authenticates with
|
|
2391
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
2392
2392
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
2393
2393
|
* If an unexpected error occurs, an {@link AuthenticationError} will be thrown with the details of the failure.
|
|
2394
2394
|
*
|
|
@@ -2666,7 +2666,7 @@ class AzureCliCredential {
|
|
|
2666
2666
|
this.timeout = options === null || options === void 0 ? void 0 : options.processTimeoutInMs;
|
|
2667
2667
|
}
|
|
2668
2668
|
/**
|
|
2669
|
-
* Authenticates with
|
|
2669
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
2670
2670
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
2671
2671
|
*
|
|
2672
2672
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -2893,7 +2893,7 @@ class AzurePowerShellCredential {
|
|
|
2893
2893
|
throw new Error(`Unable to execute PowerShell. Ensure that it is installed in your system`);
|
|
2894
2894
|
}
|
|
2895
2895
|
/**
|
|
2896
|
-
* Authenticates with
|
|
2896
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
2897
2897
|
* If the authentication cannot be performed through PowerShell, a {@link CredentialUnavailableError} will be thrown.
|
|
2898
2898
|
*
|
|
2899
2899
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -3126,7 +3126,7 @@ class MsalClientCertificate extends MsalNode {
|
|
|
3126
3126
|
const credentialName$2 = "ClientCertificateCredential";
|
|
3127
3127
|
const logger$8 = credentialLogger(credentialName$2);
|
|
3128
3128
|
/**
|
|
3129
|
-
* Enables authentication to
|
|
3129
|
+
* Enables authentication to Microsoft Entra ID using a PEM-encoded
|
|
3130
3130
|
* certificate that is assigned to an App Registration. More information
|
|
3131
3131
|
* on how to configure certificate authentication can be found here:
|
|
3132
3132
|
*
|
|
@@ -3160,7 +3160,7 @@ class ClientCertificateCredential {
|
|
|
3160
3160
|
tenantId, sendCertificateChain: options.sendCertificateChain, tokenCredentialOptions: options }));
|
|
3161
3161
|
}
|
|
3162
3162
|
/**
|
|
3163
|
-
* Authenticates with
|
|
3163
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3164
3164
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3165
3165
|
*
|
|
3166
3166
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -3211,20 +3211,20 @@ class MsalClientSecret extends MsalNode {
|
|
|
3211
3211
|
// Licensed under the MIT license.
|
|
3212
3212
|
const logger$7 = credentialLogger("ClientSecretCredential");
|
|
3213
3213
|
/**
|
|
3214
|
-
* Enables authentication to
|
|
3214
|
+
* Enables authentication to Microsoft Entra ID using a client secret
|
|
3215
3215
|
* that was generated for an App Registration. More information on how
|
|
3216
3216
|
* to configure a client secret can be found here:
|
|
3217
3217
|
*
|
|
3218
|
-
* https://
|
|
3218
|
+
* https://learn.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
|
|
3219
3219
|
*
|
|
3220
3220
|
*/
|
|
3221
3221
|
class ClientSecretCredential {
|
|
3222
3222
|
/**
|
|
3223
3223
|
* Creates an instance of the ClientSecretCredential with the details
|
|
3224
|
-
* needed to authenticate against
|
|
3224
|
+
* needed to authenticate against Microsoft Entra ID with a client
|
|
3225
3225
|
* secret.
|
|
3226
3226
|
*
|
|
3227
|
-
* @param tenantId - The
|
|
3227
|
+
* @param tenantId - The Microsoft Entra tenant (directory) ID.
|
|
3228
3228
|
* @param clientId - The client (application) ID of an App Registration in the tenant.
|
|
3229
3229
|
* @param clientSecret - A client secret that was generated for the App Registration.
|
|
3230
3230
|
* @param options - Options for configuring the client which makes the authentication request.
|
|
@@ -3241,7 +3241,7 @@ class ClientSecretCredential {
|
|
|
3241
3241
|
clientSecret, tokenCredentialOptions: options }));
|
|
3242
3242
|
}
|
|
3243
3243
|
/**
|
|
3244
|
-
* Authenticates with
|
|
3244
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3245
3245
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3246
3246
|
*
|
|
3247
3247
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -3292,7 +3292,7 @@ class MsalUsernamePassword extends MsalNode {
|
|
|
3292
3292
|
// Licensed under the MIT license.
|
|
3293
3293
|
const logger$6 = credentialLogger("UsernamePasswordCredential");
|
|
3294
3294
|
/**
|
|
3295
|
-
* Enables authentication to
|
|
3295
|
+
* Enables authentication to Microsoft Entra ID with a user's
|
|
3296
3296
|
* username and password. This credential requires a high degree of
|
|
3297
3297
|
* trust so you should only use it when other, more secure credential
|
|
3298
3298
|
* types can't be used.
|
|
@@ -3300,10 +3300,10 @@ const logger$6 = credentialLogger("UsernamePasswordCredential");
|
|
|
3300
3300
|
class UsernamePasswordCredential {
|
|
3301
3301
|
/**
|
|
3302
3302
|
* Creates an instance of the UsernamePasswordCredential with the details
|
|
3303
|
-
* needed to authenticate against
|
|
3303
|
+
* needed to authenticate against Microsoft Entra ID with a username
|
|
3304
3304
|
* and password.
|
|
3305
3305
|
*
|
|
3306
|
-
* @param tenantId - The
|
|
3306
|
+
* @param tenantId - The Microsoft Entra tenant (directory).
|
|
3307
3307
|
* @param clientId - The client (application) ID of an App Registration in the tenant.
|
|
3308
3308
|
* @param username - The user account's e-mail address (user name).
|
|
3309
3309
|
* @param password - The user account's account password
|
|
@@ -3322,7 +3322,7 @@ class UsernamePasswordCredential {
|
|
|
3322
3322
|
password, tokenCredentialOptions: options || {} }));
|
|
3323
3323
|
}
|
|
3324
3324
|
/**
|
|
3325
|
-
* Authenticates with
|
|
3325
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3326
3326
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3327
3327
|
*
|
|
3328
3328
|
* If the user provided the option `disableAutomaticAuthentication`,
|
|
@@ -3369,7 +3369,7 @@ function getAdditionallyAllowedTenants() {
|
|
|
3369
3369
|
const credentialName$1 = "EnvironmentCredential";
|
|
3370
3370
|
const logger$5 = credentialLogger(credentialName$1);
|
|
3371
3371
|
/**
|
|
3372
|
-
* Enables authentication to
|
|
3372
|
+
* Enables authentication to Microsoft Entra ID using a client secret or certificate, or as a user
|
|
3373
3373
|
* with a username and password.
|
|
3374
3374
|
*/
|
|
3375
3375
|
class EnvironmentCredential {
|
|
@@ -3377,7 +3377,7 @@ class EnvironmentCredential {
|
|
|
3377
3377
|
* Creates an instance of the EnvironmentCredential class and decides what credential to use depending on the available environment variables.
|
|
3378
3378
|
*
|
|
3379
3379
|
* Required environment variables:
|
|
3380
|
-
* - `AZURE_TENANT_ID`: The
|
|
3380
|
+
* - `AZURE_TENANT_ID`: The Microsoft Entra tenant (directory) ID.
|
|
3381
3381
|
* - `AZURE_CLIENT_ID`: The client (application) ID of an App Registration in the tenant.
|
|
3382
3382
|
*
|
|
3383
3383
|
* If setting the AZURE_TENANT_ID, then you can also set the additionally allowed tenants
|
|
@@ -3428,7 +3428,7 @@ class EnvironmentCredential {
|
|
|
3428
3428
|
}
|
|
3429
3429
|
}
|
|
3430
3430
|
/**
|
|
3431
|
-
* Authenticates with
|
|
3431
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3432
3432
|
*
|
|
3433
3433
|
* @param scopes - The list of scopes for which the token will have access.
|
|
3434
3434
|
* @param options - Optional parameters. See {@link GetTokenOptions}.
|
|
@@ -3513,11 +3513,11 @@ const logger$4 = credentialLogger("AzureDeveloperCliCredential");
|
|
|
3513
3513
|
* Azure Developer CLI is a command-line interface tool that allows developers to create, manage, and deploy
|
|
3514
3514
|
* resources in Azure. It's built on top of the Azure CLI and provides additional functionality specific
|
|
3515
3515
|
* to Azure developers. It allows users to authenticate as a user and/or a service principal against
|
|
3516
|
-
* <a href="https://learn.microsoft.com/azure/active-directory/fundamentals/">
|
|
3517
|
-
*
|
|
3516
|
+
* <a href="https://learn.microsoft.com/azure/active-directory/fundamentals/">Microsoft Entra ID</a>. The
|
|
3517
|
+
* AzureDeveloperCliCredential authenticates in a development environment and acquires a token on behalf of
|
|
3518
3518
|
* the logged-in user or service principal in the Azure Developer CLI. It acts as the Azure Developer CLI logged in user or
|
|
3519
3519
|
* service principal and executes an Azure CLI command underneath to authenticate the application against
|
|
3520
|
-
*
|
|
3520
|
+
* Microsoft Entra ID.
|
|
3521
3521
|
*
|
|
3522
3522
|
* <h2> Configure AzureDeveloperCliCredential </h2>
|
|
3523
3523
|
*
|
|
@@ -3552,7 +3552,7 @@ class AzureDeveloperCliCredential {
|
|
|
3552
3552
|
this.timeout = options === null || options === void 0 ? void 0 : options.processTimeoutInMs;
|
|
3553
3553
|
}
|
|
3554
3554
|
/**
|
|
3555
|
-
* Authenticates with
|
|
3555
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3556
3556
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3557
3557
|
*
|
|
3558
3558
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -3760,19 +3760,19 @@ class MsalOpenBrowser extends MsalNode {
|
|
|
3760
3760
|
// Licensed under the MIT license.
|
|
3761
3761
|
const logger$3 = credentialLogger("InteractiveBrowserCredential");
|
|
3762
3762
|
/**
|
|
3763
|
-
* Enables authentication to
|
|
3763
|
+
* Enables authentication to Microsoft Entra ID inside of the web browser
|
|
3764
3764
|
* using the interactive login flow.
|
|
3765
3765
|
*/
|
|
3766
3766
|
class InteractiveBrowserCredential {
|
|
3767
3767
|
/**
|
|
3768
3768
|
* Creates an instance of InteractiveBrowserCredential with the details needed.
|
|
3769
3769
|
*
|
|
3770
|
-
* This credential uses the [Authorization Code Flow](https://
|
|
3770
|
+
* This credential uses the [Authorization Code Flow](https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow).
|
|
3771
3771
|
* On Node.js, it will open a browser window while it listens for a redirect response from the authentication service.
|
|
3772
3772
|
* On browsers, it authenticates via popups. The `loginStyle` optional parameter can be set to `redirect` to authenticate by redirecting the user to an Azure secure login page, which then will redirect the user back to the web application where the authentication started.
|
|
3773
3773
|
*
|
|
3774
|
-
* For Node.js, if a `clientId` is provided, the
|
|
3775
|
-
* Follow our guide on [setting up Redirect URIs for Desktop apps that calls to web APIs](https://
|
|
3774
|
+
* For Node.js, if a `clientId` is provided, the Microsoft Entra application will need to be configured to have a "Mobile and desktop applications" redirect endpoint.
|
|
3775
|
+
* Follow our guide on [setting up Redirect URIs for Desktop apps that calls to web APIs](https://learn.microsoft.com/azure/active-directory/develop/scenario-desktop-app-registration#redirect-uris).
|
|
3776
3776
|
*
|
|
3777
3777
|
* @param options - Options for configuring the client which makes the authentication requests.
|
|
3778
3778
|
*/
|
|
@@ -3787,7 +3787,7 @@ class InteractiveBrowserCredential {
|
|
|
3787
3787
|
this.disableAutomaticAuthentication = options === null || options === void 0 ? void 0 : options.disableAutomaticAuthentication;
|
|
3788
3788
|
}
|
|
3789
3789
|
/**
|
|
3790
|
-
* Authenticates with
|
|
3790
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3791
3791
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3792
3792
|
*
|
|
3793
3793
|
* If the user provided the option `disableAutomaticAuthentication`,
|
|
@@ -3806,7 +3806,7 @@ class InteractiveBrowserCredential {
|
|
|
3806
3806
|
});
|
|
3807
3807
|
}
|
|
3808
3808
|
/**
|
|
3809
|
-
* Authenticates with
|
|
3809
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3810
3810
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3811
3811
|
*
|
|
3812
3812
|
* If the token can't be retrieved silently, this method will require user interaction to retrieve the token.
|
|
@@ -3871,13 +3871,13 @@ function defaultDeviceCodePromptCallback(deviceCodeInfo) {
|
|
|
3871
3871
|
console.log(deviceCodeInfo.message);
|
|
3872
3872
|
}
|
|
3873
3873
|
/**
|
|
3874
|
-
* Enables authentication to
|
|
3874
|
+
* Enables authentication to Microsoft Entra ID using a device code
|
|
3875
3875
|
* that the user can enter into https://microsoft.com/devicelogin.
|
|
3876
3876
|
*/
|
|
3877
3877
|
class DeviceCodeCredential {
|
|
3878
3878
|
/**
|
|
3879
3879
|
* Creates an instance of DeviceCodeCredential with the details needed
|
|
3880
|
-
* to initiate the device code authorization flow with
|
|
3880
|
+
* to initiate the device code authorization flow with Microsoft Entra ID.
|
|
3881
3881
|
*
|
|
3882
3882
|
* A message will be logged, giving users a code that they can use to authenticate once they go to https://microsoft.com/devicelogin
|
|
3883
3883
|
*
|
|
@@ -3902,7 +3902,7 @@ class DeviceCodeCredential {
|
|
|
3902
3902
|
this.disableAutomaticAuthentication = options === null || options === void 0 ? void 0 : options.disableAutomaticAuthentication;
|
|
3903
3903
|
}
|
|
3904
3904
|
/**
|
|
3905
|
-
* Authenticates with
|
|
3905
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3906
3906
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3907
3907
|
*
|
|
3908
3908
|
* If the user provided the option `disableAutomaticAuthentication`,
|
|
@@ -3921,7 +3921,7 @@ class DeviceCodeCredential {
|
|
|
3921
3921
|
});
|
|
3922
3922
|
}
|
|
3923
3923
|
/**
|
|
3924
|
-
* Authenticates with
|
|
3924
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
3925
3925
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
3926
3926
|
*
|
|
3927
3927
|
* If the token can't be retrieved silently, this method will require user interaction to retrieve the token.
|
|
@@ -3987,11 +3987,11 @@ class MsalAuthorizationCode extends MsalNode {
|
|
|
3987
3987
|
// Licensed under the MIT license.
|
|
3988
3988
|
const logger$1 = credentialLogger("AuthorizationCodeCredential");
|
|
3989
3989
|
/**
|
|
3990
|
-
* Enables authentication to
|
|
3990
|
+
* Enables authentication to Microsoft Entra ID using an authorization code
|
|
3991
3991
|
* that was obtained through the authorization code flow, described in more detail
|
|
3992
|
-
* in the
|
|
3992
|
+
* in the Microsoft Entra ID documentation:
|
|
3993
3993
|
*
|
|
3994
|
-
* https://
|
|
3994
|
+
* https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow
|
|
3995
3995
|
*/
|
|
3996
3996
|
class AuthorizationCodeCredential {
|
|
3997
3997
|
/**
|
|
@@ -4022,7 +4022,7 @@ class AuthorizationCodeCredential {
|
|
|
4022
4022
|
tenantId, tokenCredentialOptions: options || {}, logger: logger$1, redirectUri: this.redirectUri, authorizationCode: this.authorizationCode }));
|
|
4023
4023
|
}
|
|
4024
4024
|
/**
|
|
4025
|
-
* Authenticates with
|
|
4025
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
4026
4026
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
4027
4027
|
*
|
|
4028
4028
|
* @param scopes - The list of scopes for which the token will have access.
|
|
@@ -4098,7 +4098,7 @@ class MsalOnBehalfOf extends MsalNode {
|
|
|
4098
4098
|
const credentialName = "OnBehalfOfCredential";
|
|
4099
4099
|
const logger = credentialLogger(credentialName);
|
|
4100
4100
|
/**
|
|
4101
|
-
* Enables authentication to
|
|
4101
|
+
* Enables authentication to Microsoft Entra ID using the [On Behalf Of flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow).
|
|
4102
4102
|
*/
|
|
4103
4103
|
class OnBehalfOfCredential {
|
|
4104
4104
|
constructor(options) {
|
|
@@ -4114,7 +4114,7 @@ class OnBehalfOfCredential {
|
|
|
4114
4114
|
this.msalFlow = new MsalOnBehalfOf(Object.assign(Object.assign({}, this.options), { logger, tokenCredentialOptions: this.options }));
|
|
4115
4115
|
}
|
|
4116
4116
|
/**
|
|
4117
|
-
* Authenticates with
|
|
4117
|
+
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
|
4118
4118
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
|
4119
4119
|
*
|
|
4120
4120
|
* @param scopes - The list of scopes for which the token will have access.
|