Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Identity] Align with samples in other languages #14435

Closed
sadasant opened this issue Mar 23, 2021 · 4 comments · Fixed by #16698
Closed

[Identity] Align with samples in other languages #14435

sadasant opened this issue Mar 23, 2021 · 4 comments · Fixed by #16698
Assignees
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Milestone

Comments

@sadasant
Copy link
Contributor

sadasant commented Mar 23, 2021

Other languages have specific samples that show recent features that we are currently adding to Identity, so we don't have these samples yet in our repo.

One place to look for is on the .Net samples folder: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.Identity

This is related to: #13788

@sadasant sadasant added Client This issue points to a problem in the data-plane of the library. Azure.Identity labels Mar 23, 2021
@sadasant sadasant added this to the [2021] April milestone Mar 23, 2021
@maorleger maorleger modified the milestones: [2021] April, [2021] May Apr 6, 2021
@sadasant sadasant self-assigned this Apr 13, 2021
@sadasant
Copy link
Contributor Author

sadasant commented Apr 22, 2021

@maorleger recently updated the JavaScript samples. He specifically added AzureIdentityExamples.md, which covers many of the sample cases in other languages. .Net has samples in a different way. Here's a list of the topics that .Net shows in samples, and how many of them we have currently covered:

Sample about Done in JS? Language that has this
DefaultAzureCredential Yes Java
User assigned managed identity with DAC Yes Java
Authenticating Azure with managed identity Yes Java
Authenticating With Azure Stack using Azure identity Yes Java
ClientSecretCredential Yes Java
ClientCertificateCredential Yes .Net
ClientCertificateCredential with a Key Vault certificate TODO Python
Rolling certificates with ClientCertificateCredential TODO .Net
InteractiveBrowserCredential Yes .Net, Java
DeviceCodeCredential Yes .Net, Java
UsernamePasswordCredential Yes Java
AuthorizationCodeCredential Yes Java
AzureCliCredential Yes Java
VisualStudioCodeCredential Yes Java
Controlling user authentication TODO .Net
Persisting the token cache TODO .Net
Named token cache TODO .Net
Unencrypted cache TODO .Net
AuthenticationRecord TODO .Net
Silent authentication TODO .Net
Custom credentials TODO .Net
Using MSAL directly TODO .Net
On Behalf Of Flow TODO .Net

Based on this, I'll be adding different sets of documentation samples on both v1 and v2.

Sample about v1 v2 Status
Rolling certificates with ClientCertificateCredential Yes Yes v1 PR
ClientCertificateCredential with a Key Vault certificate Yes Yes v1 PR
Controlling user authentication No Yes Pending
Persisting the token cache No Yes Pending
Named token cache No Yes Pending
Unencrypted cache No Yes Pending
AuthenticationRecord No Yes Pending
Silent authentication No Yes Pending
Custom credentials Yes Yes v1 PR
Using MSAL directly Yes Yes v1 PR
On Behalf Of Flow Yes Yes v1 PR

@sadasant
Copy link
Contributor Author

sadasant commented Jun 2, 2021

Moved to the July Milestone

ghost pushed a commit that referenced this issue Jun 24, 2021
In this PR we're aligning the samples of Identity with other languages. The samples I'm adding in this PR are:

- Rolling certificates with ClientCertificateCredential ([.Net](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/samples/ClientCertificateCredentialSamples.md#rolling-certificates)).
- ClientCertificateCredential with a Key Vault Certificate ([Python](Azure/azure-sdk-for-python#18109)) (decided not to use `@azure/keyvault-certificates` because of the possible issues converting certificates from one format to another in Node).
- Custom credentials ([.Net](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/samples/DefiningCustomCredentialTypes.md#defining-custom-credential-types)).
- Using MSAL directly ([.Net](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/samples/DefiningCustomCredentialTypes.md#authenticating-with-msal-directly)).
- On Behalf Of Flow ([.Net](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/samples/DefiningCustomCredentialTypes.md#authenticating-with-the-on-behalf-of-flow)).

New samples related to the v2-specific features will be added after the Identity package is separated.

Related to #14435

---

I’ve decided to use this opportunity to:

Fix #15324

This PR also implicitly:

Fixes #15573
@sadasant
Copy link
Contributor Author

We’ve merged the v1 samples. For the v2 samples, let’s work on them next month, while we work on the user studies.

@sadasant sadasant modified the milestones: [2021] July, [2021] August Jun 25, 2021
@sadasant
Copy link
Contributor Author

sadasant commented Jun 25, 2021

TODO

There’s another sample we’re missing:

@KarishmaGhiya KarishmaGhiya linked a pull request Aug 2, 2021 that will close this issue
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants