Platform & admin
Admin
Explore the data types and operations available in Admin.
167 operations
Add a user to a team. Requires team:write permission.
attachPolicyMutationAttach a policy to a user. Requires iam:attachPolicy permission.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createAPITokenMutationCreate a new API token for the calling user. Returns the token string only once. Requires apitoken:write permission.
createArchiveJobMutationCreate a new archive job. Requires archiveJob:write permission.
createBotAPITokenMutationCreate a new API token on behalf of a bot user. Fails if the target user is not a bot. Requires apitoken:write permission.
createConditionalIAMPolicyMutationCreate an IAM policy and return its revision. Requires iam:createPolicy permission.
createConditionalIAMPolicyAttachmentMutationAttach a conditional policy for IaC ownership; an existing attachment must be imported.
createIAMPolicyMutationCreate an IAM policy. Requires iam:createPolicy permission.
createIAMPolicyAttachmentMutationAttach a policy for IaC ownership; an existing attachment must be imported.
createTaskDefinitionMutationCreate a new task definition. Requires taskDefinition:write permission.
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).
deleteArchiveJobMutationDelete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.
deleteConfigKeyMutationDelete a config key. Creates a new version. Requires tenantConfig:write permission.
deleteIAMPolicyMutationDelete an IAM policy. Requires iam:deletePolicy permission.
deleteIAMPolicyAttachmentMutationDetach the policy without deleting its user or policy.
deleteTaskDefinitionMutationDelete a task definition. Requires taskDefinition:delete permission.
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.
detachPolicyMutationDetach a policy from a user. Requires iam:detachPolicy 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.
generateJmfTokenMutationSets or replaces the JMF access token with a new random one, returned once in the result.
getAPITokenQueryFetch an API token by ID (user can only see their own tokens). Requires apitoken:read permission.
getArchiveExecutionQueryA single archive execution by id, or null if no such execution exists in the caller's tenant. Requires archiveExecution:read permission.
getArchiveJobQueryFetch a single archive job by id, scoped to the caller's tenant. Null if no such job exists. Requires archiveJob:read permission.
getConditionalIAMPolicyQueryFetch an IAM policy with its revision. Requires iam:readPolicy permission.
getConditionalIAMPolicyAttachmentQueryRead a conditional policy attachment in the current tenant.
getConfigQueryGet current tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
getConfigVersionQueryGet a specific version of tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
getExistingUserQueryRead an existing user without claiming IaC ownership.
getExistingUserByQueryLook up an existing user by email or external identifier without claiming IaC ownership.
getIAMPolicyQueryFetch an IAM policy by ID. Requires iam:readPolicy permission.
getIAMPolicyAttachmentQueryRead a policy attachment in the current tenant.
getIncomingWebhookStatsQueryGet aggregate statistics for an incoming webhook endpoint. Requires incomingWebhook:read permission.
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.
getTaskDefinitionQueryFetch a task definition by ID. Requires taskDefinition:read permission.
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.