You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Identity readme updates for more clarity upfront (Azure#13416)
This PR updates the readme for Identity with details on the different authentication options upfront. This makes it easier to link to this page from Azure#13403 instead of going through the same text there
I have used the Java and .Net readmes for Azure Identity along with Azure#12878 as reference
Copy file name to clipboardExpand all lines: sdk/identity/identity/README.md
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,18 @@
1
1
## Azure Identity client library for JavaScript
2
2
3
-
This library simplifies authentication against Azure Active Directory for Azure SDK libraries.
4
-
It provides a set of `TokenCredential` implementations which can be passed into SDK libraries
5
-
to authenticate API requests. It supports token authentication using an Azure Active Directory [service principal](https://docs.microsoft.com/cli/azure/create-an-azure-service-principal-azure-cli) or [managed identity](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview).
3
+
The Azure Identity library provides Azure Active Directory token authentication support across the Azure SDK. It provides a set of [TokenCredential](https://docs.microsoft.com/javascript/api/@azure/core-auth/tokencredential) implementations which can be used to construct Azure SDK clients which support AAD token authentication.
4
+
5
+
This library currently provides credentials for:
6
+
7
+
-[Service principal authentication](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals)
- You can sign up for a [free account](https://azure.microsoft.com/free/).
22
32
- The [Azure CLI][azure_cli] can also be useful for authenticating in a development environment, creating accounts, and managing account roles.
23
33
24
-
### Authenticate the client
34
+
### Authenticate the client in development environment
25
35
26
-
When debugging and executing code locally it is typical for a developer to use their own account for authenticating calls to Azure services. There are several developer tools which can be used to perform this authentication in your development environment.
36
+
While we recommend using managed identity or service principal authentication in your production application, it is typical for a developer to use their own account for authenticating calls to Azure services when debugging and executing code locally. There are several developer tools which can be used to perform this authentication in your development environment.
27
37
28
38
#### Authenticating via Visual Studio Code
29
39
@@ -45,6 +55,10 @@ For systems without a default web browser, the `az login` command will use the d
To authenticate Azure SDKs within web browsers, we currently offer the `InteractiveBrowserCredential`, which can be set to use redirection or popups to complete the authentication flow. It is necessary to [create an Azure App Registration](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) in the portal for your web application first.
61
+
48
62
## Key concepts
49
63
50
64
If this is your first time using `@azure/identity` or the Microsoft identity platform (Azure Active Directory), we recommend that you read [Using `@azure/identity` with Microsoft Identity Platform](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/using-azure-identity.md) first. This document will give you a deeper understanding of the platform and how to configure your Azure account correctly.
0 commit comments