Form schema for an application

The whole request form in one call, so your system can render exactly the form Zluri shows.

An app_id this organization does not have answers 404, as /roles and /licenses already do. An application that exists but has no form of its own still answers 200, with the organization’s form and scope: "generic" — that fallback is the point of this endpoint. What it no longer does is give the same 200 to an app that is not here at all, which let a stale or mistyped id render a working form that create would then refuse with APP_NOT_RESOLVED. The 404 therefore covers two conditions, and the message says which: no such application, or no form configured for the organization at all.

field_id is the ref_key, and those are the same keys field_values accepts on create — a connector round-trips without a mapping table. Two built-in fields are the exception: the people chosen in requested_for and other_subscription_users go in the top-level requested_for on create, not in field_values, which refuses both (not_accepted_here). Disabled fields are omitted, and fields come back in the configured order.

options and options_ref are mutually exclusive: an entity-backed field (a role or license) carries a reference to the endpoint that lists its values, because that list is unbounded and changes without the form changing.

The app-scoped form excludes the custom-application fields. app_name and app_url are never returned here: the application is already named by the path parameter, so an app picker and “the URL of an app not in Zluri's catalog” are both unanswerable, and a catalog item built from this schema would show two controls nobody can fill. A request for a custom app uses the generic form, which keeps them.

Two fields that ARE conditional in the UI stay, because they cannot be resolved here: other_subscription_users and licenses_required depend on who the requester says the request is for, which is not known when the schema is read. Resolve those per submission.

GET /ext/access/form-schema/generic keeps every enabled field, including the custom-application ones — it is the organization's fallback form and is reachable for a managed application that has no form of its own, so it cannot know which case it is in.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Zluri application id (24-hex).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json