Skip to content
Dashboard
Theme
Theme

Replace connection custom attribute mappings

PUT /v1/connections/{conn}/attribute_map: Replace connection custom attribute mappings.

View Markdown

PUT /v1/connections/{conn}/attribute_map

Replaces all mappings atomically; an empty set clears them. A target is either a current custom definition or a built-in profile attribute (first_name, last_name, display_name, job_title and the other catalog string attributes; never email or idp_id, and on a directory never groups). Source protocol is fixed by the owning resource (a SCIM path on a directory). A directory’s built-in mappings apply whenever its users are read (the API user view and the dsync event payloads), so a change shows at once without a backfill. Business or Enterprise is required to save custom mappings; built-in mappings are available on every plan, and clearing remains available after downgrade.

Scope
connections:write
Auth
Secret key (sk_…)
Since
1.0
  • conn string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • mappings array of CustomAttributeMapping Required

    max items 50

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/attribute_map" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mappings": [
{
"attribute": "department",
"source": "okta",
"transform": "none"
}
]
}'
Response 200
{
"mappings": [
{
"attribute": "department",
"source": "okta",
"transform": "none"
}
]
}