Update ID token claims reference with 'amr' claim details#1892
Update ID token claims reference with 'amr' claim details#1892Alex-str11 wants to merge 1 commit intoMicrosoftDocs:mainfrom
Conversation
Added information about the 'amr' claim in ID tokens, noting its presence in V1.0 and absence in V2.0.
|
@Alex-str11 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit af42109:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/identity-platform/id-token-claims-reference.md | Details |
docs/identity-platform/id-token-claims-reference.md
- Line 39, Column 114: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/entra/identity-platform/access-token-claims-reference#payload-claims' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 39, Column 114: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/entra/identity-platform/access-token-claims-reference#payload-claims' will be broken in isolated environments. Replace with a relative link. - Line 41, Column 49: [Suggestion: duplicate-alt-text - See documentation]
Alt text 'image' is duplicated. Within an article, alt text must be unique. - Line 42, Column 48: [Suggestion: duplicate-alt-text - See documentation]
Alt text 'image' is duplicated. Within an article, alt text must be unique.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
There was a problem hiding this comment.
Pull request overview
Updates the ID token claims reference to mention the amr claim and describe its observed presence in v1.0 ID tokens and absence in v2.0.
Changes:
- Adds new prose calling out the
amrclaim for ID tokens. - Adds screenshots showing token contents for v1.0 vs v2.0.
|
|
||
| The following table shows the claims that are in most ID tokens by default (except where noted). However, your app can use [optional claims](./optional-claims.md) to request more claims in the ID token. Optional claims can range from the `groups` claim to information about the user's name. | ||
|
|
||
| The payload claims should contain the information about "amr" claim as well, just like the access token doc does https://learn.microsoft.com/en-us/entra/identity-platform/access-token-claims-reference#payload-claims |
There was a problem hiding this comment.
Avoid using a bare learn.microsoft.com URL here. Use a Markdown link (or angle brackets) and follow the docs convention of removing the /en-us locale segment; since this is a page in the same folder, a relative link to ./access-token-claims-reference.md#payload-claims would be more consistent.
| The payload claims should contain the information about "amr" claim as well, just like the access token doc does https://learn.microsoft.com/en-us/entra/identity-platform/access-token-claims-reference#payload-claims | ||
| Tests show that V1.0 ID tokens will also contain the "amr" claim, and V2.0 does not. |
There was a problem hiding this comment.
These sentences read like editorial notes ("should contain", "Tests show") and don't actually add the amr claim to the reference. Consider replacing this prose with an amr row in the payload-claims table (including format and a clear note that it's only emitted in v1.0 ID tokens).
| <img width="251" height="1167" alt="image" src="https://github.com/user-attachments/assets/7fdc8cd4-94e5-4631-9568-6cb89d21b2c6" /> | ||
| <img width="330" height="786" alt="image" src="https://github.com/user-attachments/assets/73fe6720-8e9c-43f8-a86f-bda1335b4a5f" /> |
There was a problem hiding this comment.
The two screenshots are linked from github.com/user-attachments, which is not a stable or publish-friendly asset location for Microsoft Learn content, and the alt text "image" isn't descriptive for screen readers. Prefer either (1) a short, redacted JSON example in a code block, or (2) adding the images under this repo's media/ and referencing them with meaningful alt text.
|
@Alex-str11 Images can't be added to an article via a link to GitHub. You'll need to create images and include them in the PR. Note that image file names should be descriptive, all lowercase, and words/numbers separated with a hyphen. Don't use any other punctuation. Can you also remove the Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
Added information about the 'amr' claim in ID tokens, noting its presence in V1.0 and absence in V2.0.