docs: extend UAE PASS social sign-in provider documentation by suquant · Pull Request #2456 · ory/docs

suquant · 2026-02-23T15:00:14Z

Add comprehensive reference sections for the UAE PASS provider:

Configuration fields reference table
Available claims (standard + rawClaims) with SOP-level availability
User account types (SOP1/SOP2/SOP3) with verification methods
Visitor account details and profileType distinction
Build and deploy instructions for custom Kratos fork
Staging testing guide with links to UAE PASS docs
UAE PASS-specific troubleshooting (missing attributes, logout redirects)
Logout endpoint added to endpoints table

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 security@ory.com) 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).

Credits

https://gbyte.tech

CLAassistant · 2026-02-23T15:00:22Z

All committers have signed the CLA.

Add comprehensive reference sections for the UAE PASS provider: - Configuration fields reference table - Available claims (standard + rawClaims) with SOP-level availability - User account types (SOP1/SOP2/SOP3) with verification methods - Visitor account details and profileType distinction - Build and deploy instructions for custom Kratos fork - Staging testing guide with links to UAE PASS docs - UAE PASS-specific troubleshooting (missing attributes, logout redirects) - Logout endpoint added to endpoints table

vinckr

lgtm

@pi1814 would you mind also taking a look, I think you worked most with this provider?

pi1814 · 2026-03-13T09:20:22Z

We already have UAEPass docs here — any additions or extensions should go into the existing file rather than creating a new .mdx file.

…ovider-documentation

Consolidate 100_uaepass.mdx into 84_uaepass.mdx, combining Ory Console setup instructions with comprehensive CLI/self-hosted guide, rawClaims documentation, SOP level details, staging testing steps, and credits.

suquant · 2026-03-13T10:57:35Z

Hey @pi1814 , totally fair - our PR was actually opened before the existing UAE PASS docs landed (#2470 ), so we didn't have a single file to extend at the time. That's why it ended up as a separate file.

Either way, we've now merged everything into 84_uaepass.mdx and dropped the extra file. Should be clean now - happy to address any other feedback!

docs/kratos/social-signin/84_uaepass.mdx

pi1814 · 2026-03-13T13:31:27Z

docs/kratos/social-signin/84_uaepass.mdx

+      [if 'email' in claims then 'email' else null]: claims.email,
+      name: {
+        first: claims.given_name,
+        last: claims.family_name,


The last name for the UAEPass provider is mapped under claims.last_name

Actually, the provider maps LastnameEN to the FamilyName field in the Claims struct (provider_uaepass.go:172), which serializes as family_name (provider.go:60). There is a separate last_name field on the struct (line 61), but the UAE PASS provider doesn't populate it. So claims.family_name is the correct one here.

Sorry, I didn't get that properly. We actually wrote the provider ourselves and mapped lastnameEN to family_name on purpose, following the standard OIDC claim convention. The original value is still available through claims.raw_claims.lastnameEN if needed.

You're right that family_name follows the OIDC convention — however, the current implementation maps it to last_name instead.

Ref: https://github.com/ory/kratos/blob/c651ecf2ebef1fa6bd43ae57f06c4133b05ce068/selfservice/strategy/oidc/provider_uaepass.go#L177

pi1814 · 2026-03-13T13:36:39Z

docs/kratos/social-signin/84_uaepass.mdx

+        else if 'phone_number' in claims then claims.phone_number,
+      name: {
+        first: titleCase(claims.given_name),
+        last: titleCase(claims.family_name),


The last name for the UAEPass provider is mapped under claims.last_name

#2456 (comment)

docs/kratos/social-signin/84_uaepass.mdx

pi1814 · 2026-03-13T13:55:10Z

docs/kratos/social-signin/84_uaepass.mdx

+      [if 'email' in claims then 'email' else null]: claims.email,
+      name: {
+        first: claims.given_name,
+        last: claims.family_name,


UAEPass provider uses last_name instead of family_name

#2456 (comment)

docs/kratos/social-signin/84_uaepass.mdx

pi1814 · 2026-03-13T14:03:53Z

docs/kratos/social-signin/84_uaepass.mdx

+               client_id: .... # Replace with your UAE PASS client ID
+               client_secret: .... # Replace with your UAE PASS client secret
+               auth_url: https://id.uaepass.ae/idshub/authorize
+               token_url: https://id.uaepass.ae/idshub/token


auth_url and token_url are generally not necessary if issuer_url is present.

Since UAE PASS doesn't have .well-known/openid-configuration, there's no OIDC discovery. The issuer_url is only used to derive the userinfo endpoint ({issuer_url}/userinfo). The auth_url and token_url default to staging independently and aren't derived from issuer_url, so for production you do need to set them explicitly. I've added a note to make this clearer.

UAE PASS doesn't support OIDC discovery, but all three endpoints are hardcoded and derived from issuer_url:

{issuer_url}/idshub/authorize

{issuer_url}/idshub/token

{issuer_url}/idshub/userinfo

Ref: UAEPass Endpoints

Just set issuer_url to the correct base URL — auth_url and token_url are ignored:

Production: https://id.uaepass.ae (default if omitted)

Staging: https://stg-id.uaepass.ae

That's it — no other config needed.

Apply review feedback: use raw_claims (matching the JSON struct tag in provider.go) instead of rawClaims throughout Jsonnet examples, info blocks, and claims reference tables. Also fix 'an URL' to 'a URL'.

suquant · 2026-03-20T10:03:30Z

This documentation is irrelevant cause of ory/kratos#4540

suquant requested review from aeneasr, piotrmsc, unatasha8, vinckr and zepatrik as code owners February 23, 2026 15:00

suquant marked this pull request as draft February 23, 2026 15:52

suquant force-pushed the docs/uaepass-extend-provider-documentation branch from 4570a2a to b3bd53f Compare February 24, 2026 08:10

suquant marked this pull request as ready for review February 24, 2026 15:40

vinckr reviewed Mar 13, 2026

View reviewed changes

vercel bot deployed to Preview March 13, 2026 09:03 View deployment

suquant added 2 commits March 13, 2026 14:43

Merge remote-tracking branch 'ory/master' into docs/uaepass-extend-pr…

dea1dba

…ovider-documentation

docs: merge UAE PASS documentation into single file

7c85daa

Consolidate 100_uaepass.mdx into 84_uaepass.mdx, combining Ory Console setup instructions with comprehensive CLI/self-hosted guide, rawClaims documentation, SOP level details, staging testing steps, and credits.

pi1814 requested changes Mar 13, 2026

View reviewed changes

suquant added 2 commits March 13, 2026 18:35

docs: fix rawClaims to raw_claims and grammar corrections

3ad6624

Apply review feedback: use raw_claims (matching the JSON struct tag in provider.go) instead of rawClaims throughout Jsonnet examples, info blocks, and claims reference tables. Also fix 'an URL' to 'a URL'.

Merge branch 'master' into docs/uaepass-extend-provider-documentation

969d1e9

suquant closed this Mar 20, 2026

Conversation

suquant commented Feb 23, 2026

Related Issue or Design Document

Checklist

Credits

Uh oh!

CLAassistant commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vinckr left a comment

Choose a reason for hiding this comment

Uh oh!

pi1814 commented Mar 13, 2026

Uh oh!

suquant commented Mar 13, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

suquant commented Mar 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CLAassistant commented Feb 23, 2026 •

edited

Loading