API リファレンス

セッション

名前付き API トークンを作成し、clientId と Base64 でエンコードされた32バイトの token を返します。 ログインと API トークンのセッションを一覧表示します。LOGIN の token と urlToken は空です。API_TOKEN の認証情報はローカル所有者のリクエストでのみ取得できます。

型定義

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
}

操作

mutation

createApiToken

名前付き API トークンを作成し、clientId と Base64 でエンコードされた32バイトの token を返します。

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

renameSession

指定した認可済みクライアントセッションの名前を変更します。

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

revokeSession

指定したクライアントセッションと、そのアクセス権を失効させます。

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

sessions

ログインと API トークンのセッションを一覧表示します。LOGIN の token と urlToken は空です。API_TOKEN の認証情報はローカル所有者のリクエストでのみ取得できます。

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