GraphQL — cloud

Source graphql/cloud.graphql + graphql/common.graphql. Endpoint /api/v1/graphql, subscriptions over graphql-ws.

Query

FieldType@auth scopeDescription
infoCloudInfo!anon
accountAccountany
orgs(first: Int, after: String)OrgConnection!any
org(orgId: UUID!)Orgorg:read
orgMembers(orgId: UUID!, first: Int, after: String)MemberConnection!org:read
orgInstallations(orgId: UUID!, first: Int, after: String)InstallationConnection!registry:read
ownInstallationInstallationregistry:self
enrollmentRequest(userCode: String!)EnrollmentStateany

Mutation

FieldType@auth scopeDescription
signIn(input: SignInInput!)CloudSession!anon
refreshSession(refreshToken: String!)CloudSession!anon
signOutBoolean!any
patchAccount(patch: AccountPatch!)Account!any
createOrg(input: OrgInput!)Org!any
patchOrg(orgId: UUID!, patch: OrgPatch!)Org!org:write
createOrgInvitation(orgId: UUID!, input: InvitationInput!)Invitation!members:write
acceptInvitation(token: String!)Org!any
approveEnrollmentRequest(userCode: String!, input: EnrollmentApprovalInput!)EnrollmentState!registry:write
denyEnrollmentRequest(userCode: String!)EnrollmentState!registry:write

Subscription

FieldType@auth scopeDescription
events(topics: [String!]!, sinceSeq: Int)Event!anycloud topics: cloud/{orgId}/installations/{id}, cloud/{orgId}/catalogue/…, user/{userId}/notifications
installationStatus(orgId: UUID!)Installation!registry:read

type Account

FieldType@authDescription
idUUID!
emailString!
emailVerifiedBoolean!
displayNameString
localeString
platformRoleString!
statusString!
hardDeleteAfterDateTime
memberships[Membership!]
createdAtDateTime!

input AccountPatch

FieldType@authDescription
displayNameString
localeString

scalar Boolean

The `Boolean` scalar type represents `true` or `false`.

type CloudInfo

FieldType@authDescription
productString!
serverVersionString!
contractVersionString
instanceIdUUID!
apiVersions[String!]!
transportsJSON
authJSON
linksJSON

type CloudSession

FieldType@authDescription
accessTokenString!
tokenTypeString!
expiresInInt!
refreshTokenString

scalar DateTime

RFC 3339 UTC timestamp with milliseconds, e.g. 2026-10-19T12:00:00.000Z.

scalar DocId

Document-scoped id ^[A-Za-z0-9._-]{1,64}$ (.dome ids, aliases default / main).

input EnrollmentApprovalInput

FieldType@authDescription
orgIdUUID!
domeIdUUID
nameString

type EnrollmentState

FieldType@authDescription
userCodeString!
statusString!
nameString
expiresAtDateTime

type Event

Event envelope (02e §7.1): `data` is the event-kinds payload (resource / patch / revision).

FieldType@authDescription
idUUID!
seqInt!
topicString!
kindString!
tsDateTime!
dataJSON!

type EventConnection

FieldType@authDescription
nodes[Event!]!
pageInfoPageInfo!
lastSeqIntHighest seq delivered in this page.
resyncBoolean!True when the requested sinceSeq is older than the ring buffer: re-read state.

type Installation

FieldType@authDescription
idUUID!
orgIdUUID!
domeIdUUID
nameString!
platformString
osString
archString
mediaserverVersionString
statusString!
telemetryLevelString
enrolledAtDateTime
lastSeenAtDateTime

type InstallationConnection

FieldType@authDescription
nodes[Installation!]!
pageInfoPageInfo!

scalar Int

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

type Invitation

FieldType@authDescription
idUUID!
emailString!
roleOrgRole!
expiresAtDateTime!
tokenStringreturned once, by createOrgInvitation

input InvitationInput

FieldType@authDescription
emailString!
roleOrgRole!

scalar JSON

Any JSON value; the field description names the JSON Schema it is validated against.

type Member

FieldType@authDescription
userIdUUID!
emailString
displayNameString
roleOrgRole!
joinedAtDateTime!

type MemberConnection

FieldType@authDescription
nodes[Member!]!
pageInfoPageInfo!

type Membership

FieldType@authDescription
orgIdUUID!
orgNameString
roleOrgRole!

type Org

FieldType@authDescription
idUUID!
nameString!
kindString!
countryString
contactEmailString
myRoleOrgRole
createdAtDateTime!

type OrgConnection

FieldType@authDescription
nodes[Org!]!
pageInfoPageInfo!

input OrgInput

FieldType@authDescription
nameString!
kindString!
countryString
contactEmailString

input OrgPatch

FieldType@authDescription
nameString
countryString
contactEmailString

enum OrgRole

OWNER ADMIN OPERATOR AUTHOR VIEWER UNKNOWN

type PageInfo

Relay page info.

FieldType@authDescription
hasNextPageBoolean!
endCursorString

type Problem

RFC 9457 problem (also in errors[].extensions.problem).

FieldType@authDescription
typeString!
titleString!
statusInt!
codeString!
detailString
instanceString
traceIdString
errors[ProblemError!]

type ProblemError

FieldType@authDescription
pointerString!
detailString!

input SignInInput

FieldType@authDescription
emailString!
passwordString!
clientString

scalar String

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

scalar UUID

Lowercase RFC 9562 UUID (server resources: UUIDv7).

NativeMindNONC · commercial use → NativeMind sales · [email protected]