New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

UAE PASS

UAE PASS is the UAE's official digital identity platform. It allows UAE nationals, residents, and visitors to authenticate using their UAE digital identity. Ory supports both web and mobile authentication flows for UAE PASS.

Follow these steps to add UAE PASS as a social sign-in provider for your project, using the Ory Console.

  1. Go to Authentication → Social Sign-In (OIDC) in the Ory Console.
  2. Enable the Enable OpenID Connect toggle, then click Add new OpenID Connect provider.
  3. Click the UAE PASS logo to open the Configure UAE PASS screen. You may need to click Show more providers to see the full list of providers.
  4. Register your application on the UAE PASS partner portal. You will receive a Client ID and Client Secret.
  5. Paste the Client ID and Client Secret into the corresponding fields in the Ory Console's Configure UAE PASS screen.
  6. Set the Issuer URL based on your environment:
    • Production: https://id.uaepass.ae
    • Staging: https://stg-id.uaepass.ae
  7. In the Ory Console, click Save Configuration to enable UAE PASS as a social sign-in provider.
  8. In the UAE PASS application configuration, add this redirect URI to the allowed redirect URIs: https://$PROJECT_SLUG.projects.oryapis.com/self-service/methods/oidc/callback. See Redirect URI.

Data mapping​

In the Data mapping field, you can map the data returned by the sign-in provider to traits as defined in the identity schema.

To define the mapping, create a Jsonnet code snippet. Read this document to learn more about Jsonnet data mapping.

In this sample Jsonnet snippet, the user's email and name (which Ory maps from fullnameEN) are mapped to the identity schema.

local claims = std.extVar('claims');

{
identity: {
traits: {
[if 'sub' in claims then 'subject' else null]: claims.sub,
[if 'email' in claims then 'email' else null]: claims.email,
[if 'name' in claims then 'name' else null]: claims.name,
},
},
}

Configuration​

Redirect URI​

Ory always uses PKCE with UAE PASS unless you set pkce: never in the provider configuration. With PKCE, Ory sends the redirect URI https://$PROJECT_SLUG.projects.oryapis.com/self-service/methods/oidc/callback, which has no provider ID, so register that URI with UAE PASS. If you set pkce: never, register https://$PROJECT_SLUG.projects.oryapis.com/self-service/methods/oidc/callback/<provider-id> instead. Read Forcing PKCE to learn more.

Environments​

UAE PASS provides two environments. Set the issuer_url accordingly:

EnvironmentIssuer URL
Productionhttps://id.uaepass.ae
Staginghttps://stg-id.uaepass.ae

Authentication flows​

UAE PASS supports two authentication flows: web (default) and mobile. The provider defaults to the web flow. To use the mobile app-to-app flow, pass the acr_values upstream parameter at request time.

FlowACR valueUse case
Weburn:safelayer:tws:policies:authentication:level:low (default)Web applications
Mobileurn:digitalid:authentication:flow:mobileondeviceNative mobile applications

To trigger the mobile flow, include acr_values in the upstream_parameters when initiating the OIDC login or registration flow:

{
"method": "oidc",
"provider": "uaepass",
"upstream_parameters": {
"acr_values": "urn:digitalid:authentication:flow:mobileondevice"
}
}
info

The client UI is responsible for detecting whether the UAE PASS mobile app is installed on the user's device and passing the appropriate acr_values through upstream_parameters at request time. If multiple acr_values are provided (both web and mobile), UAE PASS defaults to the mobile flow.

Scopes​

UAE PASS uses custom scopes to control which user data is returned. The available scopes depend on the user type.

For UAE nationals and residents:

ScopeDescription
urn:uae:digitalid:profile:generalGeneral profile info
urn:uae:digitalid:profile:general:profileTypeProfile type
urn:uae:digitalid:profile:general:unifiedIdUnified ID

For visitors:

ScopeDescription
urn:uae:digitalid:profileBasic profile

For more information on scopes and endpoints, refer to the UAE PASS documentation.

User claims​

UAE PASS returns the following claims. Ory exposes uuid as top-level sub and maps email, fullnameEN, firstnameEN, and lastnameEN to top-level claims. The upstream sub and other claims remain under claims.raw_claims.

ClaimDescription
subSubject identifier (unique ID)
emailEmail address
fullnameENFull name (English)
firstnameENFirst name (English)
lastnameENLast name (English)
fullnameARFull name (Arabic)
firstnameARFirst name (Arabic)
lastnameARLast name (Arabic)
uuidUUID identifier
unifiedIDUAE unified identifier
idnIdentity number
userTypeProfile type (SOP1/SOP2/SOP3)
nationalityENNationality
genderGender
dobDate of birth
mobileMobile number

User types:

  • SOP1: UAE National
  • SOP2: Resident
  • SOP3: Visitor

Advanced data mapping​

To map additional UAE PASS claims to your identity schema, use a more comprehensive Jsonnet snippet:

local claims = std.extVar('claims');

{
identity: {
traits: {
[if 'sub' in claims then 'subject' else null]: claims.sub,
[if 'email' in claims then 'email' else null]: claims.email,
[if 'name' in claims then 'name' else null]: {
full: claims.name,
[if 'given_name' in claims then 'first' else null]: claims.given_name,
[if 'last_name' in claims then 'last' else null]: claims.last_name,
},
[if 'fullnameAR' in claims.raw_claims then 'name_ar' else null]: {
full: claims.raw_claims.fullnameAR,
[if 'firstnameAR' in claims.raw_claims then 'first' else null]: claims.raw_claims.firstnameAR,
[if 'lastnameAR' in claims.raw_claims then 'last' else null]: claims.raw_claims.lastnameAR,
},
[if 'unifiedID' in claims.raw_claims then 'unified_id' else null]: claims.raw_claims.unifiedID,
[if 'userType' in claims.raw_claims then 'user_type' else null]: claims.raw_claims.userType,
[if 'nationalityEN' in claims.raw_claims then 'nationality' else null]: claims.raw_claims.nationalityEN,
[if 'gender' in claims.raw_claims then 'gender' else null]: claims.raw_claims.gender,
[if 'dob' in claims.raw_claims then 'date_of_birth' else null]: claims.raw_claims.dob,
[if 'mobile' in claims.raw_claims then 'phone' else null]: claims.raw_claims.mobile,
},
},
}
note

Your Ory Identity schema must include the corresponding fields for any claims you map. Update your identity schema to include the fields you need before configuring the data mapping.

Account identifiers​

Ory uses the uuid returned by UAE PASS to identify linked accounts, as required by UAE PASS's integration guidelines. Jsonnet receives that UUID as claims.sub and the upstream sub as claims.raw_claims.sub. UAE PASS must return a non-empty UUID; otherwise Ory rejects registration, sign-in, and account linking.

Connections created using the upstream sub as their identifier do not match UUID-based sign-ins. Migrate or relink those connections before switching to UUID-based sign-in.

Troubleshooting​

When you add a social sign-in provider, you can encounter common problems such as:

  • Redirect URI mismatch
  • Redirect loops during registration
  • Domain verification issues

To troubleshoot those issues, read Social sign-in troubleshooting.