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

docs: added documentation for data mapping of SAML attributes #2078

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

deepakprabhakara
Copy link

@deepakprabhakara deepakprabhakara commented Mar 21, 2025

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

@CLAassistant
Copy link

CLAassistant commented Mar 21, 2025

CLA assistant check
All committers have signed the CLA.

@deepakprabhakara deepakprabhakara changed the title Added documentation for data mapping of SAML attributes docs: added documentation for data mapping of SAML attributes Mar 21, 2025
Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great 🎉
I have a few small change requests for a bit cleaner style, let me know what you think

Comment on lines +357 to +362
:::note

Important: Ensure that the appropriate identity schema is created before mapping attributes. The email attribute is natively
available in `claims.email`, everything else is nested under `claims.raw_claims`.

:::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::note
Important: Ensure that the appropriate identity schema is created before mapping attributes. The email attribute is natively
available in `claims.email`, everything else is nested under `claims.raw_claims`.
:::
:::warning
Ensure that the appropriate identity schema is created before mapping attributes. The email attribute is natively
available in `claims.email`, everything else is nested under `claims.raw_claims`.
:::

If you want to emphasize the importance here I would recommend to use "warning" or "danger" admonition - best use those if something will break prod if you get it wrong


:::

Example: Mapping `firstName` and `lastName` from the SAML Identity Provider to the Ory identity schema (traits)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Example: Mapping `firstName` and `lastName` from the SAML Identity Provider to the Ory identity schema (traits)
#### Example SAML data mapping
Mapping `firstName` and `lastName` from the SAML Identity Provider to the Ory identity schema (traits).

imo a bit cleaner to use a dedicated headline here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants