Data Structures

The Cumulonimbus API uses consistent structures to streamline parsing data. Below are the structures that Cumulonimbus will respond with.

List

Note

Items in this structure will be stripped of extraneous properties. Properties that will not be present in this structure type are marked with a comment in the structure.

interface List<T> {
  count: number;
  items: T[];
}

User

interface User {
  id: string;
  username: string;
  email: string; // Omitted in List<T>
  staff: boolean; // Omitted in List<T>
  domain: string; // Omitted in List<T>
  subdomain?: string; // Omitted in List<T>
  verifiedAt?: string; // Omitted in List<T>
  bannedAt?: string; // Omitted in List<T>
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
}

Session

interface Session {
  id: number;
  name: string;
  exp: number; // Omitted in List<T>
  permissionFlags: number | null; // Omitted in List<T>
  usedAt: string; // Omitted in List<T>
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
}

Success

interface Success {
  code: string;
  message: string;
}

Error

interface Error {
  code: string;
  message: string;
}

Instruction

interface Instruction {
  id: string;
  name: string;
  description: string;
  steps: string[]; // Omitted in List<T>
  filename: string; // Omitted in List<T>
  fileContent: string; // Omitted in List<T>
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
}

Domain

interface Domain {
  id: string;
  subdomains: boolean;
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
}

SuccessfulAuth

interface SuccessfulAuth {
  token: string;
  exp: number;
}

File

interface File {
  id: string;
  name: string;
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
  userID: string; // Omitted in List<T>
  size: number; // Omitted in List<T>
}

SuccessfulUpload

interface SuccessfulUpload {
  url: string;
  thumbnail: string;
  manage: string;
}

KillSwitch

interface KillSwitch {
  id: number;
  name: string;
  state: boolean;
}

SecondFactor

interface SecondFactor {
  id: string;
  name: string;
  type: 'totp' | 'webauthn'; // Omitted in List<T>
  createdAt: string; // Omitted in List<T>
  updatedAt: string; // Omitted in List<T>
}

SecondFactorBaseRegistration

interface SecondFactorBaseRegistration {
  token: string;
  exp: number;
  type: 'totp' | 'webauthn';
}

SecondFactorTOTPRegistration

interface SecondFactorTOTPRegistration extends SecondFactorBaseRegistration {
  type: 'totp';
  secret: string;
  algorithm: string;
  digits: number;
  period: number;
}

SecondFactorWebAuthnRegistration

The specific structure for PublicKeyCredentialCreationOptionsJSON can be found here

interface SecondFactorWebAuthnRegistration
  extends SecondFactorBaseRegistration,
    PublicKeyCredentialCreationOptionsJSON {
  type: 'webauthn';
}

SecondFactorRegisterSuccess

interface SecondFactorRegisterSuccess {
  id: string;
  name: string;
  type: 'totp' | 'webauthn';
  backupCodes?: string[];
}

SecondFactorBackupRegisterSuccess

interface SecondFactorBackupRegisterSuccess {
  codes: string[];
}

ScopedSessionCreate

interface ScopedSessionCreate extends Session {
  token: string;
}