API reference · Access
Save an Access application against the reviewed revision
PUT
/v1/orgs/{org}/access/applications/{application}- Permission
access.applications.manage- Audit log
access.application.update- Operation
access.applications.replace
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
application | path | string | yes | for example "app_01h455vb4pex5vsknk084sn02q" |
Idempotency-Key | header | string | no | One 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-assignment | header | string | no | Select 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
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | 1 to 100 characters |
zone | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
hostnames | array of string or object | yes | 1 to 16 items |
sessionLifetimeSeconds | integer | yes | 900 to 43200 |
requiredProvider | string or null | yes | |
ruleset | object or null | yes | |
ruleset.id | string | yes | for example "rul_01h455vb4pex5vsknk084sn02q" |
ruleset.revision | string | yes | Opaque revision: dot-joined counters. |
revision | string | yes | Opaque revision: dot-joined counters. |
Response 200
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | for example "app_01h455vb4pex5vsknk084sn02q" |
orgId | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
zone | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
hostnames | array of object | yes | |
hostnames[].id | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
hostnames[].name | string | yes | |
hostnames[].pathPrefixes | array of string | yes | 1 to 16 items |
sessionLifetimeSeconds | integer | yes | 900 to 43200 |
requiredProvider | string or null | yes | |
ruleset | object or null | yes | |
ruleset.id | string | yes | for example "rul_01h455vb4pex5vsknk084sn02q" |
ruleset.revision | string | yes | Opaque revision: dot-joined counters. |
revision | string | yes | Opaque revision: dot-joined counters. |
readiness | object | yes | |
readiness.state | string | yes | one of "unconfigured", "pending", "applied" |
readiness.savedRevision | string or null | yes | |
readiness.appliedRevision | string or null | yes | |
readiness.identity | object or null | yes | |
readiness.identity.signInHost | string or null | yes | |
readiness.identity.issuer | string or null | yes | |
readiness.identity.failure | object or null | yes | |
readiness.identity.failure.code | string | yes | one 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.at | string (date-time) | yes | UTC, ISO 8601. |
readiness.identity.publicCheckAt | string (date-time) or null | yes | |
readiness.serving | "unavailable" | yes | |
readiness.blockers | array of string | yes | 0 to 16 items |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |