PlainApp
API-referentie

Sessies

Een benoemd API-token maken en clientId en het Base64-gecodeerde token van 32 bytes teruggeven. Aanmeld- en API-tokensessies opvragen. Voor LOGIN zijn token en urlToken leeg; API_TOKEN-inloggegevens vereisen verzoeken van de lokale eigenaar.

Typedefinities

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
}

Bewerkingen

mutation

createApiToken

Een benoemd API-token maken en clientId en het Base64-gecodeerde token van 32 bytes teruggeven.

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

renameSession

De opgegeven sessie van een geautoriseerde client hernoemen.

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

revokeSession

De opgegeven clientsessie en de bijbehorende toegang intrekken.

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

sessions

Aanmeld- en API-tokensessies opvragen. Voor LOGIN zijn token en urlToken leeg; API_TOKEN-inloggegevens vereisen verzoeken van de lokale eigenaar.

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