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.

Sign up for GitHub

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

Jump to bottom

Reworded the attribute sharing content #4734

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

Reworded the attribute sharing content #4734

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10af53b
reworded the attribute sharing content
himeshsiriwardana Sep 3, 2024
98bcc10
Update en/includes/guides/authentication/user-attributes/enable-attri…
himeshsiriwardana Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...ncludes/guides/authentication/user-attributes/enable-attributes-for-oidc-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,19 +139,19 @@ _A sample userinfo response is given below:_
}
```

## Prioritize local account attributes
## Prioritize sharing local attributes

{{ product_name }} offers the capability to share attributes of a local account during federated a{{ product_name }}uthentication, provided that there exists a local account linked with the federated identity. To prioritize the sharing of attributes from linked local accounts, follow the steps given below:
In a scenario where a user with a local account in {{product_name}}, logs in using [federated authentication]({{base_path}}/guides/authentication/federated-login/), you may want to prioritize sharing local user attributes with the application over those provided by the external identity provider. Follow the steps below to set this priority for sharing user attributes.

1. On the {{ product_name }} Console, go to **Applications**.
2. Select your application and go to its **User Attributes** tab.
3. Scroll down and under **Linked Accounts**, select **Prioritize local account attributes**.

![Prioritize local account attributes]({{base_path}}//assets/img/guides/applications/attributes/oidc/prioritize-local-account-attributes.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

Once enabled, the tokens issued from this application during federated authentication with an [external identity provider]({{base_path}}/guides/authentication/#supported-external-idps) will contain the attributes of the local account which is linked with the entity identified by the subject claim of the token issued by the external identity provider.
4. Click **Update** to save the changes.

If there is no such linked local account, {{ product_name }} will return the user attributes retrieved from the external identity provider.
When enabled, tokens will include attributes from the linked local user account identified by the subject claim provided by the external identity provider. If a local user account does not exist, {{ product_name }}, instead, will share the user attributes obtained from the external identity provider.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
When enabled, tokens will include attributes from the linked local user account identified by the subject claim provided by the external identity provider. If a local user account does not exist, {{ product_name }}, instead, will share the user attributes obtained from the external identity provider.
When enabled, {{product_name}} looks for a linked local user account based on the subject claim provided by the external identity provider. If a local user account is found, the local attributes will be shared with the application. If a local account is not found, user attributes obtained from the external identity provider will be shared with the application.

Copy link
Contributor

Choose a reason for hiding this comment

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

This seems clear and in order.


!!! note
When [JIT provisioning]({{base_path}}/guides/authentication/jit-user-provisioning/#how-jit-provisioning-works) is enabled for the external identity provider, {{ product_name }} ensures that the attributes of the associated local account synchronize with the external identity provider upon each federated login.
Expand Down