Replace connection custom attribute mappings
PUT /v1/connections/{conn}/attribute_map: Replace connection custom attribute mappings.
PUT /
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
Path parameters
Section titled “Path parameters”connstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”mappingsarray of CustomAttributeMapping Requiredmax items 50
Responses
Section titled “Responses”- 200 OK CustomAttributeMap
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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" } ]}'const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/attribute_map", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "mappings": [ { "attribute": "department", "source": "okta", "transform": "none" } ] }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/attribute_map", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "mappings": [ { "attribute": "department", "source": "okta", "transform": "none", }, ], },)data = response.json(){ "mappings": [ { "attribute": "department", "source": "okta", "transform": "none" } ]}