Preview the catalog mapping of an IdP payload
POST /v1/attribute_catalogue/preview: Preview the catalog mapping of an IdP payload.
POST /
Maps a sample IdP payload (SAML attributes or OIDC claims) to the attribute catalog exactly as a sign-in would, with the same bounds. Nothing is stored or logged; the payload is only echoed back as the mapped result.
- Scope
environment:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”protocolstring Requiredone of
saml,oidcattributesobjectclaimsobject
Responses
Section titled “Responses”- 200 OK AttributePreview
- 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
- 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 POST \ "https://api.ohauthcat.com/v1/attribute_catalogue/preview" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "protocol": "saml"}'const response = await fetch("https://api.ohauthcat.com/v1/attribute_catalogue/preview", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "protocol": "saml" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/attribute_catalogue/preview", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "protocol": "saml", },)data = response.json(){ "object": "attribute_preview", "first_name": "Jane", "last_name": "Doe", "groups": [ "Engineering" ], "attributes": {}, "unmapped": [ "example_unmapped" ]}