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

Claims sharing #5295

Merged
merged 21 commits into from
Jan 29, 2025
Merged

Claims sharing #5295

merged 21 commits into from
Jan 29, 2025

Conversation

susanharper-okta
Copy link
Contributor

@susanharper-okta susanharper-okta commented Jan 23, 2025

Description:

  • What's changed? Claims sharing
  • Is this PR related to a Monolith release? yes2025.01.2

Netlify link: https://preview-5295--reverent-murdock-829d24.netlify.app/docs/guides/configure-claims-sharing/oktaoidc/main/

Resolves:

@acrolinxdevdocs-okta

This comment was marked as outdated.

@eng-info-dev-github-bot

Netlify Preview URL for the changes: https://preview-5295--reverent-murdock-829d24.netlify.app

@susanharper-okta susanharper-okta force-pushed the sdh-okta846184-claimssharing branch from 8833ee4 to 84259b9 Compare January 24, 2025 23:17
@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta

This comment was marked as outdated.

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/add-an-external-idp/main/oktatookta/appatidp.md 86 35 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-amr-claims-mapping/index.md 86 100 4 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/index.md 86 100 4 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/index.md 81 66 66 70 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/addanidp.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpauthclaimssharing.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpresponsetitle.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idptype.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpupdaterequest.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpupdateresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/redirect.md 86 100 3 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/addanidp.md 86 6 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpauthclaimssharing.md 90 32 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpresponsetitle.md 86 5 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idptype.md 86 3 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpupdaterequest.md 90 30 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpupdateresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/redirect.md 86 100 100 100 100
packages/@okta/vuepress-site/docs/guides/index.md 81 56 56 87 100

@@ -0,0 +1 @@
When you use SAML 2.0 with claims sharing, the data shared between an Okta IdP and an Okta SP is included in the SAML response in a new reserved tag in the `Extension` section called `OktaAuth`. This content is communicated in JSON within the `Assertion` response and contains information about authentication performed at the Okta IdP org. The entire assertion is securely encrypted with a published encryption key from the SP org.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When you use SAML 2.0 with claims sharing, the data shared between an Okta IdP and an Okta SP is included in the SAML response in a new reserved tag in the `Extension` section called `OktaAuth`. This content is communicated in JSON within the `Assertion` response and contains information about authentication performed at the Okta IdP org. The entire assertion is securely encrypted with a published encryption key from the SP org.
When you use SAML 2.0 with claims sharing, the data that's shared between an Okta IdP and an Okta SP is included in the SAML response in a new reserved tag in the `Extension` section called `OktaAuth`. This content is communicated in JSON within the `Assertion` response and contains information about authentication performed at the Okta IdP org. The entire assertion is securely encrypted with a published encryption key from the SP org.

@@ -0,0 +1 @@
When you use OpenID Connect with claims sharing, the data shared between an Okta IdP and an Okta SP is included in the ID token under a new reserved claim name called `okta_auth`. The `okta_auth` payload within the ID token response contains information about authentication performed at the Okta IdP org.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When you use OpenID Connect with claims sharing, the data shared between an Okta IdP and an Okta SP is included in the ID token under a new reserved claim name called `okta_auth`. The `okta_auth` payload within the ID token response contains information about authentication performed at the Okta IdP org.
When you use OpenID Connect with claims sharing, the data that's shared between an Okta IdP and an Okta SP is included in the ID token under a new reserved claim name called `okta_auth`. The `okta_auth` payload within the ID token response contains information about authentication performed at the Okta IdP org.

#### What you need

* An Okta SP org and an Okta IdP org configured for an [Okta-to-Okta](/docs/guides/add-an-external-idp/oktatookta/main/) use case. This guide covers how to configure authentication claims sharing for this scenario.
* The **Okta-to-Okta Claims Sharing** feature enabled for both orgs. To enable, go to **Settings | Features**, locate the feature, and enable.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* The **Okta-to-Okta Claims Sharing** feature enabled for both orgs. To enable, go to **Settings | Features**, locate the feature, and enable.
* The **Okta-to-Okta Claims Sharing** feature enabled for both orgs. Go to **Settings | Features**, locate the feature, and then enable it.


### Accepted authenticators

All authenticators that are natively performed on the Okta IdP are accepted. This includes authenticators such as WebAuthn, password, Okta Verify, Okta FastPass, SMS, Email, and so on. Claim sharing doesn't currently support the use of any Custom Authenticators for MFA, such as using another IdP or smart card.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
All authenticators that are natively performed on the Okta IdP are accepted. This includes authenticators such as WebAuthn, password, Okta Verify, Okta FastPass, SMS, Email, and so on. Claim sharing doesn't currently support the use of any Custom Authenticators for MFA, such as using another IdP or smart card.
All authenticators that are natively performed on the Okta IdP are accepted. This includes authenticators such as WebAuthn, password, Okta Verify, Okta FastPass, SMS, email, and so on. Claim sharing doesn't currently support the use of any Custom Authenticators for MFA, such as using another IdP or smart card.

* **Disallow specific authentication methods**: If you specify authentication methods to disallow, then the SP org disallows those methods.
* **Allow specific authentication methods**: If you specify authentication methods to allow, then the SP org only considers those methods.

After you define these conditions, if you still haven't met the policy requirement, then the SP org redirects you to verify any locally configured authenticator. If there's no local authenticator available, or the enrollment policy for a particular authenticator is disabled, then the SP org displays an error.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After you define these conditions, if you still haven't met the policy requirement, then the SP org redirects you to verify any locally configured authenticator. If there's no local authenticator available, or the enrollment policy for a particular authenticator is disabled, then the SP org displays an error.
After you define these conditions, if you still haven't met the policy requirement, then the SP org redirects you to verify any locally configured authenticator. If there's no local authenticator available, or the enrollment policy for a particular authenticator is disabled, then the SP org displays an error.


### Global session policy example

This same concept applies for the global session policy. Without trust claims enabled, if you have only the password authenticator configured in the SP org, you can't save a global session policy rule that requires MFA.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This same concept applies for the global session policy. Without trust claims enabled, if you have only the password authenticator configured in the SP org, you can't save a global session policy rule that requires MFA.
This same concept applies to the global session policy. Without trust claims enabled, if you have only the password authenticator configured in the SP org, you can't save a global session policy rule that requires MFA.

Configure a simple routing rule for the IdP in the Okta SP org.

* Click **Add Routing Rule**.
* Name it and leave the defaults.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Name it and leave the defaults.
* Enter a name. Don't change the default values.

1. Access your Okta SP org using your browser's privacy or incognito mode to avoid false positive or negative results.
1. Click **Sign in with {Name of IdP}** on the Okta sign-in page.

If everything is configured properly:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If everything is configured properly:
This is the result if everything is configured properly:

* The authenticators configured in the authentication policy prompt the user for more authentication.
* After successful authentication, the user is redirected to the <StackSnippet snippet="redirect" inline /> specified in the Okta IdP org app.

If something is configured incorrectly, the authorization response contains error information to help you resolve the issue. See the [FAQ](#faq) section next.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If something is configured incorrectly, the authorization response contains error information to help you resolve the issue. See the [FAQ](#faq) section next.
If something is configured incorrectly, the authorization response contains error information to help you resolve the issue. See the [FAQ](#faq) section.

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/add-an-external-idp/main/oktatookta/appatidp.md 86 35 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-amr-claims-mapping/index.md 86 100 4 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/index.md 86 100 4 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/index.md 81 66 64 70 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/addanidp.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpauthclaimssharing.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpresponsetitle.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idptype.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpupdaterequest.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/idpupdateresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktaoidc/redirect.md 86 100 3 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/addanidp.md 86 6 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpauthclaimssharing.md 90 32 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpresponsetitle.md 86 5 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idptype.md 86 3 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpupdaterequest.md 90 30 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/idpupdateresponse.md 100 100 100 100 100
packages/@okta/vuepress-site/docs/guides/configure-claims-sharing/main/oktasaml/redirect.md 86 100 100 100 100
packages/@okta/vuepress-site/docs/guides/index.md 81 56 56 87 100

@susanharper-okta susanharper-okta added the docs release Tagged to be released during scheduled docs release label Jan 29, 2025
@annejuan-okta annejuan-okta changed the base branch from master to release-2025.1.2 January 29, 2025 21:06
@annejuan-okta annejuan-okta merged commit 7d3a37a into release-2025.1.2 Jan 29, 2025
4 checks passed
@annejuan-okta annejuan-okta deleted the sdh-okta846184-claimssharing branch January 29, 2025 21:07
@annejuan-okta annejuan-okta mentioned this pull request Jan 29, 2025
annejuan-okta added a commit that referenced this pull request Jan 30, 2025
* [OKTA-844514] 2025.01.2 Release Notes (#5300)

* First pass at RN

* Fix formatting and add IGA RN item

* Update packages/@okta/vuepress-site/docs/release-notes/2025-okta-identity-engine/index.md

Co-authored-by: Brian Duffield - Okta <[email protected]>

* Update packages/@okta/vuepress-site/docs/release-notes/2025-okta-identity-engine/index.md

Co-authored-by: Brian Duffield - Okta <[email protected]>

* Update packages/@okta/vuepress-site/docs/release-notes/2025/index.md

* Update packages/@okta/vuepress-site/docs/release-notes/2025/index.md

---------

Co-authored-by: Brian Duffield - Okta <[email protected]>

* Claims sharing (#5295)

* update

* updates

* update

* request response

* example updates and more

* update doc to make stack selector guide

* Venkat updates and oidc examples

* new files for new URL for claims sharing and complete first draft of content

* save

* policies

* first shot at PR

* framework

* review comments

* lars and ansu reviews

* review comments

* faqs moved

* more review updates

* acrolinx love

* Lars updates

* finalreviews

* editorial review

* Link fix and missing feature in classic

---------

Co-authored-by: Brian Duffield - Okta <[email protected]>
Co-authored-by: Susan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Barbara docs release Tagged to be released during scheduled docs release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants