Docs

API reference · Access

List Access applications with their hostnames and pending readiness

GET/v1/orgs/{org}/access/applications
Permission
access.applications.read
Operation
access.applications.list

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
limitqueryintegerno1 to 100; default 50
cursorquerystringnofor example "app_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"

Response 200

FieldTypeRequiredNotes
itemsarray of objectyes
items[].idstringyesfor example "app_01h455vb4pex5vsknk084sn02q"
items[].orgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].namestringyes
items[].zonestringyesfor example "zone_01h455vb4pex5vsknk084sn02q"
items[].hostnamesarray of objectyes
items[].hostnames[].idstringyesfor example "hostname_01h455vb4pex5vsknk084sn02q"
items[].hostnames[].namestringyes
items[].hostnames[].pathPrefixesarray of stringyes1 to 16 items
items[].sessionLifetimeSecondsintegeryes900 to 43200
items[].requiredProviderstring or nullyes
items[].rulesetobject or nullyes
items[].ruleset.idstringyesfor example "rul_01h455vb4pex5vsknk084sn02q"
items[].ruleset.revisionstringyesOpaque revision: dot-joined counters.
items[].revisionstringyesOpaque revision: dot-joined counters.
items[].readinessobjectyes
items[].readiness.statestringyesone of "unconfigured", "pending", "applied"
items[].readiness.savedRevisionstring or nullyes
items[].readiness.appliedRevisionstring or nullyes
items[].readiness.identityobject or nullyes
items[].readiness.identity.signInHoststring or nullyes
items[].readiness.identity.issuerstring or nullyes
items[].readiness.identity.failureobject or nullyes
items[].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"
items[].readiness.identity.failure.atstring (date-time)yesUTC, ISO 8601.
items[].readiness.identity.publicCheckAtstring (date-time) or nullyes
items[].readiness.serving"unavailable"yes
items[].readiness.blockersarray of stringyes0 to 16 items
items[].createdAtstring (date-time)yesUTC, ISO 8601.
items[].updatedAtstring (date-time)yesUTC, ISO 8601.
nextCursorstring or nullyes