Platform & admin

Admin

Explore the data types and operations available in Admin.

167 operations

addTeamMemberMutation

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

attachPolicyMutation

Attach a policy to a user. Requires iam:attachPolicy permission.

compileSchemaXMLQuery

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

createAPITokenMutation

Create a new API token for the calling user. Returns the token string only once. Requires apitoken:write permission.

createArchiveJobMutation

Create a new archive job. Requires archiveJob:write permission.

createBotAPITokenMutation

Create a new API token on behalf of a bot user. Fails if the target user is not a bot. Requires apitoken:write permission.

createConditionalIAMPolicyMutation

Create an IAM policy and return its revision. Requires iam:createPolicy permission.

createConditionalIAMPolicyAttachmentMutation

Attach a conditional policy for IaC ownership; an existing attachment must be imported.

createIAMPolicyMutation

Create an IAM policy. Requires iam:createPolicy permission.

createIAMPolicyAttachmentMutation

Attach a policy for IaC ownership; an existing attachment must be imported.

createTaskDefinitionMutation

Create a new task definition. Requires taskDefinition:write permission.

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

deleteArchiveJobMutation

Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.

deleteConfigKeyMutation

Delete a config key. Creates a new version. Requires tenantConfig:write permission.

deleteIAMPolicyMutation

Delete an IAM policy. Requires iam:deletePolicy permission.

deleteIAMPolicyAttachmentMutation

Detach the policy without deleting its user or policy.

deleteTaskDefinitionMutation

Delete a task definition. Requires taskDefinition:delete permission.

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.

detachPolicyMutation

Detach a policy from a user. Requires iam:detachPolicy 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.

generateJmfTokenMutation

Sets or replaces the JMF access token with a new random one, returned once in the result.

getAPITokenQuery

Fetch an API token by ID (user can only see their own tokens). Requires apitoken:read permission.

getArchiveExecutionQuery

A single archive execution by id, or null if no such execution exists in the caller's tenant. Requires archiveExecution:read permission.

getArchiveJobQuery

Fetch a single archive job by id, scoped to the caller's tenant. Null if no such job exists. Requires archiveJob:read permission.

getConditionalIAMPolicyQuery

Fetch an IAM policy with its revision. Requires iam:readPolicy permission.

getConditionalIAMPolicyAttachmentQuery

Read a conditional policy attachment in the current tenant.

getConfigQuery

Get current tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.

getConfigVersionQuery

Get a specific version of tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.

getExistingUserQuery

Read an existing user without claiming IaC ownership.

getExistingUserByQuery

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

getIAMPolicyQuery

Fetch an IAM policy by ID. Requires iam:readPolicy permission.

getIAMPolicyAttachmentQuery

Read a policy attachment in the current tenant.

getIncomingWebhookStatsQuery

Get aggregate statistics for an incoming webhook endpoint. Requires incomingWebhook:read permission.

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.

getTaskDefinitionQuery

Fetch a task definition by ID. Requires taskDefinition:read permission.

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.