Docs

API reference · Access

Save Access session settings and the sign-in label against the reviewed revision

PUT/v1/orgs/{org}/access/authority
Permission
access.authority.manage
Audit log
access.authority.configure
Operation
access.authority.configure

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
Idempotency-KeyheaderstringnoOne key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Request body

FieldTypeRequiredNotes
revisionstring or nullyes
sessionLifetimeSecondsintegeryes900 to 43200
signInLabelstring or nullno

Response 200

FieldTypeRequiredNotes
orgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
realmstring or nullyes
revisionstring or nullyes
sessionLifetimeSecondsintegeryes900 to 43200
signInLabelstring or nullyes
signInHoststring or nullyes
issuerstring or nullyes
allowedbooleanyes
createdAtstring (date-time) or nullyes
updatedAtstring (date-time) or nullyes
readinessobjectyes
readiness.statestringyesone of "unconfigured", "pending", "applied"
readiness.savedRevisionstring or nullyes
readiness.appliedRevisionstring or nullyes
readiness.identityobject or nullyes
readiness.identity.signInHoststring or nullyes
readiness.identity.issuerstring or nullyes
readiness.identity.failureobject or nullyes
readiness.identity.failure.codestringyesone of "keycloak_unavailable", "keycloak_refused", "realm_conflict", "realm_drifted", "issuer_mismatch", "issuer_migration_required", "edge_client_keys_missing", "provider_egress_unavailable", "provider_refused", "sign_in_host_unreachable"
readiness.identity.failure.atstring (date-time)yesUTC, ISO 8601.
readiness.identity.publicCheckAtstring (date-time) or nullyes
readiness.serving"unavailable"yes
readiness.blockersarray of stringyes0 to 16 items