Skip to content

docs(scim): clarify directory sync custom attribute paths #3345

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

Draft
NicolasLopes7 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(scim): clarify directory sync custom attribute paths #3345

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions docs/guides/configure/auth-strategies/enterprise-connections/directory-sync.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,23 @@ Attribute definitions are configured at the enterprise connection level and shar

#### How SCIM attribute mapping works

Clerk exposes a `/Schemas` endpoint that your IdP queries to discover what attributes Clerk accepts. In addition to the standard User schema, Clerk advertises a custom extension schema (`urn:clerk:scim:schemas:extension:custom:2.0:User`) that accepts any attribute name and maps it directly to the corresponding `publicMetadata` key.
Clerk exposes a `/Schemas` endpoint that your IdP queries to discover what attributes Clerk accepts. In addition to the standard User schema, Clerk advertises a custom extension schema (`urn:ietf:params:scim:schemas:extension:clerk:2.0:User`) that lets your IdP send arbitrary attributes Clerk would not otherwise accept.

For each custom attribute, the SCIM path can target a top-level core attribute (e.g., `title`), a nested attribute (e.g., `name.givenName`), or an attribute under any extension namespace your IdP populates — including the standard enterprise extension or Clerk's custom extension.

To configure SCIM attribute mapping for a custom attribute:

1. First, [define your custom attributes](/docs/guides/configure/auth-strategies/enterprise-connections/custom-attribute-mapping#define-custom-attributes) at the enterprise connection level.
1. In the Clerk Dashboard, navigate to the **Directory sync** tab on your connection.
1. Scroll to the **Attribute mapping** card. In the **Custom attributes** section, select **Map custom attribute**.
1. In the **SCIM attribute** field, enter the SCIM schema path your IdP sends (e.g., `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department`).
1. In the **SCIM attribute** field, enter the SCIM path your IdP sends:
- `urn:ietf:params:scim:schemas:extension:clerk:2.0:User.department` if your IdP sends `department` under Clerk's custom extension.
- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department` if your IdP uses the standard enterprise extension.
1. In the **Clerk User attribute** dropdown, select one of your custom attributes.
1. Select **Map attribute**.
1. In your IdP, ensure the attribute is configured to be pushed via SCIM.

For example, you might map the shared `department` attribute to `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department` in Okta.
For example, in Okta you can configure the `department` profile attribute to be sent under Clerk's custom extension (`urn:ietf:params:scim:schemas:extension:clerk:2.0:User.department`), then map that path to your shared `department` attribute in Clerk.

## Role mapping

Expand Down
Loading