API-Referenz

Sitzungen

Ein benanntes API-Token erstellen und clientId sowie das Base64-kodierte 32-Byte-token zurückgeben. Anmelde- und API-Token-Sitzungen auflisten. Bei LOGIN sind token und urlToken leer; API_TOKEN-Zugangsdaten erfordern Anfragen des lokalen Eigentümers.

Typdefinitionen

graphql
type Mutation {
  createApiToken(name: String!): CreatedApiToken!
  renameSession(clientId: ID!, name: String!): Boolean!
  revokeSession(clientId: ID!): Boolean!
}

type Query {
  sessions: [Session!]!
}

type CreatedApiToken {
	clientId: ID!
	token: String!
}

scalar Instant

type Session {
	clientId: ID!
	clientName: String!
	type: SessionType!
	clientIp: String!
	osName: String!
	osVersion: String!
	appName: String!
	appVersion: String!
	lastSeenAt: Instant
	lastActive: Instant!
	createdAt: Instant!
	updatedAt: Instant!
}

enum SessionType {
	LOGIN
	API_TOKEN
}

Operationen

mutation

createApiToken

Ein benanntes API-Token erstellen und clientId sowie das Base64-kodierte 32-Byte-token zurückgeben.

graphql
mutation createApiToken($name: String!) {
  createApiToken(name: $name) { clientId token }
}
mutation

renameSession

Benennt die angegebene autorisierte Clientsitzung um.

graphql
mutation renameSession($clientId: ID!, $name: String!) {
  renameSession(clientId: $clientId, name: $name)
}
mutation

revokeSession

Widerruft die angegebene Clientsitzung und deren Zugriff.

graphql
mutation revokeSession($clientId: ID!) {
  revokeSession(clientId: $clientId)
}
query

sessions

Anmelde- und API-Token-Sitzungen auflisten. Bei LOGIN sind token und urlToken leer; API_TOKEN-Zugangsdaten erfordern Anfragen des lokalen Eigentümers.

graphql
query sessions {
  sessions { clientId clientName type clientIp osName osVersion appName appVersion }
}