Platform & admin

IAM

Explore the data types and operations available in IAM.

43 operations

addTeamMemberMutation

Add a user to a team. Requires team:write permission.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createTeamMutation

Create a new team. Requires team:write permission.

createTeamMembershipMutation

Create a new membership without adopting an existing one. Requires team:write permission.

createUserMutation

Create a new service account. The created user is always a BOT — HUMAN users are provisioned by Control. Requires user:write permission.

dataChangeEventsSubscription

Subscribe 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).

deleteTeamMutation

Delete a team. Requires team:delete permission.

deleteTeamMembershipMutation

Delete only the membership, leaving the user and team intact. Requires team:write permission.

deleteUserMutation

Delete a service account. HUMAN accounts are provisioned by Control and cannot be deleted here. Requires user:delete permission.

generateDefaultDataQueryQuery

Generate 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.

getExistingUserQuery

Read an existing user without claiming IaC ownership.

getExistingUserByQuery

Look up an existing user by email or external identifier without claiming IaC ownership.

getMagicQueryGraphQLQuery

Resolves 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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getServiceAccountQuery

Read a BOT service account. Returns null for HUMAN and KIOSK accounts.

getTeamQuery

Fetch a team by ID. Requires team:read permission.

getTeamByQuery

Find a team by its unique name in the authenticated tenant. Requires team:read permission.

getTeamMembersQuery

Fetch members of a team. Requires team:read permission.

getTeamMembershipQuery

Read a team membership by its own identity. Requires team:read permission.

getUserQuery

Fetch a user by ID. Requires user:read permission.

getUserByQuery

Fetch a user by external ID or email. Requires user:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every 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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

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

listDataChangeEventTopicsQuery

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

listMagicQueriesQuery

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

listTeamsQuery

List teams with pagination. Requires team:list 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.

pingQuery

Health check endpoint

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.

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.

setTeamMemberRoleMutation

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

teamsForUserQuery

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

updateTeamMutation

Update a team. Only provided fields are changed. Requires team:write permission.

updateUserMutation

Update a service account. Only provided fields are changed. HUMAN accounts are provisioned by Control and cannot be updated. Requires user:write permission.

upsertTeamMutation

Create or update a team. Requires team:write permission.

upsertUserMutation

Create 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.