Replace the attribute catalogue
PUT /v1/attribute_catalogue: Replace the attribute catalogue.
PUT /v1/attribute_catalogue
Replaces the environment’s custom definitions (at most 50) while retaining the fixed standard and predefined catalogue. Custom names use lowercase ASCII letters, digits and underscores, start with a letter, and contain at most 64 characters. Fixed standard and predefined catalogue names are reserved. Custom types are string, string_array, boolean and integer. Removing a definition removes its connection and directory mappings atomically. Custom configuration requires Business or Enterprise. Existing saved configuration remains after a downgrade; removal remains available.
- Scope
environment:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”objectstring Requiredattributesarray of object Required
Responses
Section titled “Responses”- 200 OK AttributeCatalogue
- 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
- 409 Codes: idempotency_key_reused and resource-specific conflicts. 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/attribute_catalogue" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "object": "attribute_catalogue", "attributes": [ { "name": "Acme Corp", "type": "string", "standard": true, "description": "Primary SSO connection for Acme Corp." } ]}'const response = await fetch("https://api.ohauthcat.com/v1/attribute_catalogue", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "object": "attribute_catalogue", "attributes": [ { "name": "Acme Corp", "type": "string", "standard": true, "description": "Primary SSO connection for Acme Corp." } ] }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/attribute_catalogue", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "object": "attribute_catalogue", "attributes": [ { "name": "Acme Corp", "type": "string", "standard": True, "description": "Primary SSO connection for Acme Corp.", }, ], },)data = response.json(){ "object": "attribute_catalogue", "attributes": [ { "name": "Acme Corp", "type": "string", "standard": true, "description": "Primary SSO connection for Acme Corp." } ]}