Update Clearance¶

Update a user's clearance

URI Template

PATCH /api/clearances/{username}

{username}

Request Body

interface UpdateClearanceRequest {
  level: SignificanceLevelType;
}

Response Type

interface ClearanceInfo {
  username: string;
  level: SignificanceLevelType;
  issuedBy: string;
  issueTime: string;  // RFC 3339 timestamp
  hasCommandPrivileges: boolean;
}

Related Types

enum SignificanceLevelType {
  NONE = "NONE",
  WATCH = "WATCH",
  WARNING = "WARNING",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}