---
title: "Preview or sync hosted IdP claims into a tenant user mapping"
method: POST
path: "/tenant/idp-mapping/preview"
---

# Preview or sync hosted IdP claims into a tenant user mapping

`POST /tenant/idp-mapping/preview`

## Request

- Base URL: `https://api.gravityads.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gravityads.dev/tenant/idp-mapping/preview`
- Auth: HTTP bearer

## Request body

- object
  - `provider` string: IdP provider: generic_oidc, clerk, auth0, workos, google_workspace, microsoft_entra or feishu.
  - `claims` object, required: Raw IdP claims. Email may be supplied only for transient hashing and is never returned.
  - `role_mapping` object: Optional external role/group to GravityAds role mapping.
  - `tenant_mapping` object: Optional external org/tenant id to GravityAds tenant_id mapping.
  - `default_roles` string[]
  - `sync_user` boolean
  - `replace_roles` boolean

## Response `200`

IdP mapping preview

- object
  - `schema_version` 'gravityads.hosted_idp_mapping.v1', required
  - `status` string, required
  - `tenant_id` string, required
  - `provider` string, required
  - `external_tenant_id` string
  - `tenant_match` boolean
  - `tenant_mapping_match` boolean
  - `tenant_reference_hashes` string[]
  - `user_id` string
  - `user_id_hash` string
  - `email_hash_prefix` string
  - `has_email_hash` boolean
  - `directory_sync_user` object
  - `roles` string[]
  - `role_mapping` object
  - `role_source_count` integer
  - `mapped_role_count` integer
  - `sync_user_requested` boolean, required
  - `synced_count` integer
  - `role_assigned_count` integer
  - `role_revoked_count` integer
  - `replace_roles` boolean
  - `database_url_configured` boolean
  - `hosted_auth_context` object
  - `raw_email_returned` false, required
  - `raw_secrets_returned` false, required

---

[API](https://skmtc.dev/gravityads/apis/gravityads-api.md) · [All operations](https://skmtc.dev/gravityads/apis/gravityads-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gravityads/apis/gravityads-api/revisions/124cd07d534d?raw)