Skip to content

chore: update docs for ui_locales param in sso callback url #5

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

Merged
vtsl-DevRev merged 2 commits into from
Apr 21, 2026
Merged

chore: update docs for ui_locales param in sso callback url #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b8ae36
updated sso markdown example to include ui_locales param
vtsl-DevRev Apr 21, 2026
8257189
updated doc for wrong BCP-47 locale example
vtsl-DevRev Apr 21, 2026
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
21 changes: 18 additions & 3 deletions customer_portal_jwt_sso_login/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,23 @@ policies across their applications on DevRev.
this format for the URL:
`http://support.devrev.ai/<your-org-slug>/callback/sso?jwt=<onetime-token>`

6. **Custom Redirects**: The above redirection URL will take the user to the default landing page of your customer portal. If you need custom redirection, use the `redirect_to` param. This param accepts a relative path after your slug and will redirect the user to the specified path post login.
Example: `http://support.devrev.ai/<your-org-slug>/callback/sso?jwt=<onetime-token>&redirect_to=/article/ART-1` will login the user and redirect them to `http://support.devrev.ai/<your-org-slug>/article/ART-1` post login.
6. **Custom Redirects**: The above redirection URL will take the user to the default landing page of your customer portal. If you need custom redirection, use the `redirect_to` param. This param accepts a relative path after your slug and will redirect the user to the specified path post login.
Example: `http://support.devrev.ai/<your-org-slug>/callback/sso?jwt=<onetime-token>&redirect_to=/article/ART-1` will login the user and redirect them to `http://support.devrev.ai/<your-org-slug>/article/ART-1` post login.

7. **Preferred UI Locale**: To render the customer portal in a specific language for the user, use the `ui_locales` param. This param accepts a single locale tag in [BCP-47](https://www.rfc-editor.org/info/bcp47) format (e.g., `en-US`, `fr-FR`, `ja-JP`, `pt-BR`) and sets the portal's UI language for the session initiated by this SSO redirect.

Example: `http://support.devrev.ai/<your-org-slug>/callback/sso?jwt=<onetime-token>&ui_locales=fr-FR` will log the user in and render the customer portal in French.

`ui_locales` can be combined with `redirect_to`, for example:
`http://support.devrev.ai/<your-org-slug>/callback/sso?jwt=<onetime-token>&redirect_to=/article/ART-1&ui_locales=ja-JP`

> **Note:** Before the portal can honor a locale passed via `ui_locales`, it must be enabled in two places:
>
> 1. **Add the language** to your portal's supported languages from **Settings → Language and Region → Portal Supported Languages**.
>
> 2. **Publish the language** from **Portal Settings**.
>
> Until both steps are completed, the locale will be ignored and the portal will fall back to the default locale configured in portal settings. The same applies to any unsupported or malformed BCP-47 tag.

## The Onetime Token 🛡️

Expand All @@ -46,4 +61,4 @@ To bolster security, the one-time token possesses the following key features:

2. **Guaranteed One-Time Exchange**: Upon redirection to the customer portal, the one-time token can be exchanged for an authenticated session on the customer portal only once. Any attempt to reuse the token will result in a denied request, and any previously authenticated sessions associated with that token may be revoked to maintain a high level of security.

With these guidelines, you can ensure the security of your customer interactions with the DevRev platform, protecting their data and maintaining a trusted environment.
With these guidelines, you can ensure the security of your customer interactions with the DevRev platform, protecting their data and maintaining a trusted environment.
Loading