Skip to content
Dashboard
Theme
Theme

Profiles

Map a connection-scoped profile to a trusted local identity.

View Markdown

A successful code exchange returns a profile alongside the access token. Its required fields include id, organization_id, connection_id, connection_type, idp_id, email and email_domain_verified=true.

access_policy is optional. It is guest only when the sign-in was admitted under the organization’s guest domain policy, and absent for every other sign-in. email_domain_verified stays true for guests, so check access_policy to tell a guest from a member of the customer’s own domains. The same field is on GET /v1/sso/profile.

The stable prof_ ID is derived from the connection and IdP subject. It is scoped to that connection: the same subject in another connection is another identity. Store the profile ID and organization with your local user link. Check the expected organization before granting access.

The verified-domain check proves the email belongs to an allowed organization domain. It does not authorize merging accounts with the same email. Link an existing account only through your application’s trusted, authenticated linking process.

Names may be null. Groups and attribute fields depend on the provider and configuration; do not assume every provider supplies them. The optional role can be absent or null, both meaning no assigned role. Role rules can assign it from eligible evidence; directory roles can differ when their evidence differs from sign-in.

Mapped custom values appear under custom_attributes as strings, string arrays, booleans or signed 64-bit integers. These are application data, not verified sign-in-policy evidence or OhAuthCat account authority. Missing keys do not preserve previous mapped values. See attribute mapping and bounds before parsing or using them; JavaScript consumers must account for integer precision beyond the exact number range. Validate the fields your application requires and apply least privilege when information is absent.

Effective policy hints describe force-SSO exclusions, session lifetime and IdP-initiated eligibility. Your application must enforce its own session behavior; core does not take ownership of your sessions. See sign-in policies.

The token contains no profile PII. Treat the profile itself as sensitive: avoid logging full emails, raw attributes, SAML responses or tokens. Use identifiers and request IDs for diagnostics.

See schemas for the exact profile shape and existing auth for session boundaries.

Imported profiles can carry an explicit legacy_ids map. Core keeps those mappings scoped to the environment and connection and exposes them in the profile object returned by token exchange, in /v1/sso/profile and in forwarded flows. They are not profile fields embedded in the access JWT. Use this continuity when linking the old provider identity to your local user; do not infer an account merge from matching email alone. Native profile IDs remain connection scoped. See session cutover for the separate imported-profile operation.