Platform & admin
IAM
Explore the data types and operations available in IAM.
43 operations
Add a user to a team. Requires team:write permission.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createTeamMutationCreate a new team. Requires team:write permission.
createTeamMembershipMutationCreate a new membership without adopting an existing one. Requires team:write permission.
createUserMutationCreate a new service account. The created user is always a BOT — HUMAN users are provisioned by Control. Requires user:write permission.
dataChangeEventsSubscriptionSubscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
deleteTeamMutationDelete a team. Requires team:delete permission.
deleteTeamMembershipMutationDelete only the membership, leaving the user and team intact. Requires team:write permission.
deleteUserMutationDelete a service account. HUMAN accounts are provisioned by Control and cannot be deleted here. Requires user:delete permission.
generateDefaultDataQueryQueryGenerate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
getExistingUserQueryRead an existing user without claiming IaC ownership.
getExistingUserByQueryLook up an existing user by email or external identifier without claiming IaC ownership.
getMagicQueryGraphQLQueryResolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getServiceAccountQueryRead a BOT service account. Returns null for HUMAN and KIOSK accounts.
getTeamQueryFetch a team by ID. Requires team:read permission.
getTeamByQueryFind a team by its unique name in the authenticated tenant. Requires team:read permission.
getTeamMembersQueryFetch members of a team. Requires team:read permission.
getTeamMembershipQueryRead a team membership by its own identity. Requires team:read permission.
getUserQueryFetch a user by ID. Requires user:read permission.
getUserByQueryFetch a user by external ID or email. Requires user:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listTeamsQueryList teams with pagination. Requires team:list permission.
listUsersQueryList users with pagination and filtering. Requires user:list permission.
magicQueryQueryExecutes 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.
pingQueryHealth check endpoint
removeTeamMemberMutationRemove a user from a team. Requires team:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setTeamMemberRoleMutationSet a team member's role. Team admins administer the stacks the team owns. Requires team:write permission.
teamsForUserQueryTeams an account belongs to. Requires team:read permission.
updateTeamMutationUpdate a team. Only provided fields are changed. Requires team:write permission.
updateUserMutationUpdate a service account. Only provided fields are changed. HUMAN accounts are provisioned by Control and cannot be updated. Requires user:write permission.
upsertTeamMutationCreate or update a team. Requires team:write permission.
upsertUserMutationCreate or update a service account. Only BOT accounts are writable through the API — HUMAN users are provisioned by Control and are read-only here. Requires user:write permission.