azure-activedirectory-identitymodel-extensions-for-dotnet
azure-activedirectory-identitymodel-extensions-for-dotnet copied to clipboard
AzureAD
Question- Where is documentation for this library?
I looked at wiki, readme.md and other places that I thought would find the latest version of this library but get disappointed.
the readme.md instead of getting started has some non-informative information that really doesn't help to use this library. the developer needs to go through the test files and read one by one to learn how to use this library.
if I wanted to add something to the documentation I would write how different method works to sign, to check for the different algorithms. how to use differents method to create a token. I saw there is a couple of creating methods that returning different types, all of them named as createSOMETHINGtoken() but the usage is not defined and it's up to the developer figure out and put the puzzle together, it's a guesswork
@brockallen I saw the confused emoji. It is unlikely we can get all the documentation in for the 5.2.0 release. So I am looking for suggestions on priority.
@mhamri thanks for your suggestion.
@2211868381 @ghost @grokit @nickolasacosta @DUSK can you add your priorities here?
@brentschmaltz Show us basic usage, such as how to create a token, how to select an algorithm, Encode And Decode a token, thank you.
I would also like API reference besides documentation, so that user can view API on browser without browsing the source code directly. I'm using Sandcastle in my C# projects, and I think it is the de-facto documentation generator. https://ewsoftware.github.io/SHFB/ https://github.com/EWSoftware/SHFB
If we are using SHFB, then SHFB needs to be installed on developer's machine in order to generate the documentations (not just a simple Nuget package). This is a potential development dependency.
I can provide an example of SHFB output for this project, if anyone is interested.
As for sample usage, I saw an answer on Stack Overflow explaining JWE with this library. https://stackoverflow.com/a/44195678/4451732
There is the start of a documentation in the wiki, with links to reference documentation for two of the assemblies
@jmprieur Thanks a lot for the pointer. Nevertheless I would like to see API documentation for System.IdentityModel.Tokens.Jwt.
@franklinyu : my impression is that we don't generate it currently. I'll make sure that it is generated (which will take a few days as the library needs to be emboarded in the pipeline)
In addition, what's the relationship between System.IdentityModel.* and Microsoft.IdentityModel.*? I thought System.IdentityModel.Tokens.Jwt should belong to WIF API because of the System. prefix.
oh, sorry, I mis-read it. yes … System.IdentityModel.Tokens.Jwt is a different library? (not from this repo?) is it?
It is this library, and it is mentioned in the wiki page you pointed me to. Source available at
azure-activedirectory-identitymodel-extensions-for-dotnet/src/System.IdentityModel.Tokens.Jwt/
That's why it confused me.
@franklinyu about System.IdentityModel.Tokens.Jwt. You are correct that the other System.IdentityModel assemblies are thought of being part of WIF. The new assemblies in this open source effort are Microsoft.IdentityModel and are not thought of being part of WIF. The reason is that most of WIF was developed with WS* in mind and was tailored for SOAP payloads and were developed in 2004.
When we needed support for .Net Core, we used these open source assemblies to provide this support. We recently added WsFederation and SAML support. We are determining how much WS* we provided support for.
I've been searching all morning for example/tutorial code on how to use/implement SAML. I cannot find ANYTHING. There is no code. Does anyone have anything anywhere on how to use SAML?
https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki Here is all we have.