Platform & admin

Admin

Explore the data types and operations available in Admin.

167 operations

iacStackStateQuery

Read current deployment state; source is held separately in Git.

iacStackValuesQuery

List the current value of every variable the stack holds, set ones only, with secrets listed by name and never by value. Requires stack read access.

iacUpdateEditingMutation

Update authoring presence without changing source or deployment state.

iacUpdateStackRulesMutation

Change a stack's rules. Every change is recorded. Requires stack administration; invalid values are refused with INVALID_RULES.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

iamAuthoringCapabilitiesQuery

Conditional authoring availability and supported actions, business attributes, operators and limits. Metadata only; does not grant access.

listArchiveExecutionsQuery

Run history for one archive job, newest run first (by startedAt), with pagination. Scoped to the caller's tenant. Requires archiveExecution:list permission.

listArchiveJobsQuery

List the tenant's archive jobs as a cursor-paginated connection, filtered and sorted in the database. Requires archiveJob:list permission.

listBotAPITokensQuery

List the API tokens belonging to a bot user. Returns an empty list if the target user is not a bot. Requires apitoken:list permission.

listConfigVersionsQuery

List version history for tenant configuration, newest first, with pagination. Requires tenantConfig:list permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listEndpointLogsQuery

List endpoint logs with pagination. Requires incomingWebhook:read permission.

listIAMActionsQuery

List all available IAM actions grouped by resource. Requires authentication.

listIAMPoliciesQuery

List IAM policies with pagination. Requires iam:listPolicies permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listMyAPITokensQuery

List the current user's API tokens with pagination. Requires apitoken:list permission.

listTaskDefinitionsQuery

List task definitions with pagination. Requires taskDefinition:list permission.

listTeamsQuery

List teams with pagination. Requires team:list permission.

listUserPoliciesQuery

List policies attached to a user. Requires iam:listUserPolicies permission.

listUsersQuery

List users with pagination and filtering. Requires user:list permission.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.

meQuery

Who the caller is and which tenant they are acting in. Requires authentication but no permission: a caller asking who they are needs no authority over anything.

myEffectivePermissionsQuery

Get current user's effective permissions. Requires authentication.

pingQuery

Health check endpoint

platformInfoQuery

Which build of the platform is answering. Compare across deployments to tell them apart, or across time to notice that the server changed under a cached set of workarounds.

previewIAMPolicyQuery

Simulate a draft alongside a user's attached policies, or replacing one attachment. Requires iam:listUserPolicies and iam:readPolicy. Supplied time, network and sample values are simulation only; no resource records are read or permissions changed.

queryLogsQuery

Query logs across all drains (webhook, execution, edge app, archive). Requires log:list permission.

removeJmfTokenMutation

Removes the JMF access token. While the endpoint is on, anything that can reach it can then post signals.

removeTeamMemberMutation

Remove a user from a team. Requires team:write permission.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

revealJmfTokenMutation

Shows the JMF access token so an operator can set up a device. Every reveal is recorded with who and when.

revokeAPITokenMutation

Revoke an API token. Requires apitoken:revoke permission.

revokeBotAPITokenMutation

Revoke an API token belonging to a bot user. Fails if the token's owner is not a bot. Requires apitoken:revoke permission.

rollbackConfigMutation

Rollback to a previous config version. Creates a new version with the old data. Requires tenantConfig:write permission.

runArchiveJobMutation

Run an archive job immediately, regardless of its schedule or isEnabled flag. Enqueues the work and returns a PENDING ArchiveExecution to poll; the run itself happens asynchronously. Requires an authenticated user and archiveJob:execute permission.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

setJmfTokenMutation

Sets or replaces the JMF access token with one you supply, e.g. the one your devices already send.

setTeamMemberRoleMutation

Set a team member's role. Team admins administer the stacks the team owns. Requires team:write permission.

settingsQuery

This instance's settings. Needs tenantPreferences:read or tenantConfig:read; each section then needs the permission that guarded its data before Settings existed, and is null with an error without it.

streamLogsSubscription

Stream logs across drains (webhook, execution, edge app) as they are written. Requires log:list permission.

teamsForUserQuery

Teams an account belongs to. Requires team:read permission.

updateAppAccessSettingsMutation

Saves the app access section. Other sections are untouched.

updateArchiveJobMutation

Update an archive job. Only provided fields are changed. Requires archiveJob:write permission.

updateConditionalIAMPolicyMutation

Update an IAM policy, refusing the change if it was edited since expectedRevision. Requires iam:updatePolicy permission.

updateConfigMutation

Update tenant configuration. Creates a new version. For SECRET entries with null value, the existing secret is preserved. Requires tenantConfig:write permission.

updateFulfillmentSettingsMutation

Save only the fulfillment section, preserving every other settings section

updateIAMPolicyMutation

Update an IAM policy. Requires iam:updatePolicy permission.

updateImposingSettingsMutation

Saves the imposing section. Other sections are untouched.

updateJmfSettingsMutation

Turns the direct JMF endpoint on or off. The token is untouched.