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

providerstring

IdP provider: generic_oidc, clerk, auth0, workos, google_workspace, microsoft_entra or feishu.

claimsobject required

Raw IdP claims. Email may be supplied only for transient hashing and is never returned.

role_mappingobject

Optional external role/group to GravityAds role mapping.

tenant_mappingobject

Optional external org/tenant id to GravityAds tenant_id mapping.

default_rolesstring[]
sync_userboolean
replace_rolesboolean

Response

IdP mapping preview

schema_version'gravityads.hosted_idp_mapping.v1' required
statusstring required
tenant_idstring required
providerstring required
external_tenant_idstring
tenant_matchboolean
tenant_mapping_matchboolean
tenant_reference_hashesstring[]
user_idstring
user_id_hashstring
email_hash_prefixstring
has_email_hashboolean
directory_sync_userobject
rolesstring[]
role_mappingobject
role_source_countinteger
mapped_role_countinteger
sync_user_requestedboolean required
synced_countinteger
role_assigned_countinteger
role_revoked_countinteger
replace_rolesboolean
database_url_configuredboolean
hosted_auth_contextobject
raw_email_returnedfalse required
raw_secrets_returnedfalse required

Changes

No recorded changes to this operation across all 1 revision of this API.