User Profile Management

The User Profile Management endpoints cover account identity, beta-gate free-tier setup, audit activity, and the per-user encrypted vault. Use these endpoints to inspect or update profiles, audit recent API calls, manage free-tier provisioning during the beta, or store arbitrary key-value secrets scoped to a realm.

User Profiles

GET /api/v1/users/{id}

Retrieve a user profile by ID. Admins can view any user; regular users can only view their own profile. This endpoint works even for banned users (read-only access).

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	User ID to retrieve

Response

200

{
  "statusCode": 200,
  "message": "User retrieved successfully",
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "username": "john_doe",
    "alias": "John Doe",
    "email": "john.doe@example.com",
    "is_admin": false,
    "is_banned": false,
    "metadata": {},
    "created_at": "2024-12-01T10:00:00.000Z",
    "updated_at": "2025-01-15T10:30:00.000Z"
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid ID format"
}

Error Code	Title	Description	Resolution
INVALID_ID_FORMAT	Invalid ID format	The provided ID must be a 24-character hexadecimal string	Ensure the ID is exactly 24 characters long and contains only hexadecimal characters (0-9, a-f)

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token
TOKEN_EXPIRED	Authentication token expired	The provided authentication token has expired	Obtain a new token by logging in again or refreshing your session

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access
ACCOUNT_BANNED	Account banned	Your account has been banned and cannot access this resource	Contact support for information about your account status

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "User not found"
}

Error Code	Title	Description	Resolution
USER_NOT_FOUND	User not found	The requested user does not exist or has been deleted	Verify the user ID is correct

SDK Usage

const user = await client.api.users.get({ id: "507f1f77bcf86cd799439011" });

PATCH /api/v1/users/{id}

Update a user profile. Regular users can update their own alias and password (with current_password verification). Admins can update any user and set is_admin/is_banned flags.

Caution

Admin users cannot be banned. Remove admin privileges before banning a user.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	User ID to update

Request Body

Field	Type	Required	Description
alias	string	No	New display name/alias (1–100 chars).
public_key	string	No	ED25519 public key (exactly 64 hexadecimal characters). Used for cryptographic identity and verification.
metadata	object	No	Custom metadata object for storing additional user information. Can include nested objects.
password	string	No	New password. Must be at least 12 characters, 3 of 4 character classes. Requires current_password for verification.
current_password	string	No	Current password. Required when setting a new password for verification (8–128 chars).
is_admin	boolean	No	Admin status (admin-only field). Grants full system access.
is_banned	boolean	No	Ban status (admin-only field). Admin users cannot be banned.

Response

200

{
  "statusCode": 200,
  "message": "User updated successfully",
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "username": "john_doe",
    "alias": "John Smith",
    "email": "john.doe@example.com",
    "public_key": "a1b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdef1234",
    "is_admin": false,
    "is_banned": false,
    "metadata": {},
    "created_at": "2024-12-01T10:00:00.000Z",
    "updated_at": "2025-01-15T14:45:00.000Z"
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed"
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input parameters	One or more request parameters failed validation	Check the error message for specific field requirements and correct your input
INVALID_ID_FORMAT	Invalid ID format	The provided ID must be a 24-character hexadecimal string	Ensure the ID is exactly 24 characters long and contains only hexadecimal characters (0-9, a-f)
INVALID_PUBLIC_KEY_FORMAT	Invalid public key format	Public key must be exactly 64 hexadecimal characters (ED25519 format)	Provide a valid ED25519 public key as a 64-character hexadecimal string
WEAK_PASSWORD	Password does not meet requirements	Password must be at least 12 characters, 3 of 4 character classes	Choose a password with at least 12 characters, 3 of 4 character classes
CURRENT_PASSWORD_REQUIRED	Current password required	You must provide your current password to set a new password	Include the current_password field in your request
CURRENT_PASSWORD_INCORRECT	Current password incorrect	The provided current password does not match your account password	Verify your current password and try again

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token
TOKEN_EXPIRED	Authentication token expired	The provided authentication token has expired	Obtain a new token by logging in again or refreshing your session

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access
ACCOUNT_BANNED	Account banned	Your account has been banned and cannot access this resource	Contact support for information about your account status
CANNOT_BAN_ADMIN	Cannot ban admin users	Admin users cannot be banned for security reasons	Remove admin privileges before banning this user
CANNOT_MODIFY_OTHER_USER	Cannot modify other user	Regular users can only modify their own profile	You can only update your own profile, or request admin access

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "User not found"
}

Error Code	Title	Description	Resolution
USER_NOT_FOUND	User not found	The requested user does not exist or has been deleted	Verify the user ID is correct

SDK Usage

const updated = await client.api.users.update({
  id: "507f1f77bcf86cd799439011",
  data: { alias: "John Smith" }
});

GET /api/v1/users/me/free-tier-status

Return the account’s free-tier / beta-gate status, including whether the gate is enabled, whether this account is unlocked, whether it already owns a free server, and (advisory, point-in-time) why a claim is currently blocked. This endpoint never attempts a claim.

This endpoint takes no parameters.

Response

200

{
  "statusCode": 200,
  "message": "Free-tier status retrieved",
  "data": {
    "gate_enabled": true,
    "unlocked": false,
    "has_free_server": false,
    "can_claim": false,
    "claim_blocked_reason": "invite_required"
  }
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

429

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}

Error Code	Title	Description	Resolution
RATE_LIMIT_EXCEEDED	Rate limit exceeded	You have exceeded the rate limit for this endpoint	Wait before making additional requests, or upgrade your plan for higher limits

SDK Usage

const status = await client.api.users.getFreeTierStatus();

POST /api/v1/users/me/redeem-invite

Redeem a single-use invite code to unlock free-tier server claiming during the beta, then immediately provision a free server. Idempotent if already unlocked. No-op (no code consumed) when the beta gate is disabled.

Note

Requires a first-party JWT. Auth tokens, HTTP Basic, and impersonation are rejected.

This endpoint takes no parameters.

Request Body

Field	Type	Required	Description
code	string	Yes	The invite code (case/format-insensitive). 1–64 characters.

Response

200

{
  "statusCode": 200,
  "message": "Invite code redeemed. Your free server is being prepared.",
  "data": {
    "unlocked": true,
    "required": true,
    "claim_blocked_reason": "none",
    "server": { "id": "507f1f77bcf86cd799439099" },
    "project": { "id": "507f1f77bcf86cd799439098" },
    "container": null
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "This invite code is invalid, expired, or already used."
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input parameters	One or more request parameters failed validation	Check the error message for specific field requirements and correct your input
INVALID_INVITE_CODE	Invalid invite code	The submitted invite code could not be redeemed because it is unknown, already used, disabled, or expired	Check the code for typos, or request a new invite code from an administrator

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

429

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}

Error Code	Title	Description	Resolution
RATE_LIMIT_EXCEEDED	Rate limit exceeded	You have exceeded the rate limit for this endpoint	Wait before making additional requests, or upgrade your plan for higher limits

SDK Usage

const result = await client.api.users.redeemInviteCode({
  data: { code: "HOODY-7Q4K-9F2M-3B8T-XR5W-2HKD-1" }
});

POST /api/v1/users/me/retry-setup

Manually claim a free-tier server and create the default project and container. Idempotent — safe to call if already provisioned.

This endpoint takes no parameters.

Request Body

Field	Type	Required	Description
region	string	No	Optional preferred region override. Lowercase letters, digits, and hyphens; max 50 chars.

Response

200

{
  "statusCode": 200,
  "data": {
    "server": { "id": "507f1f77bcf86cd799439099" },
    "project": { "id": "507f1f77bcf86cd799439098" },
    "container": null
  }
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "An invite code is required to claim your free server during the beta."
}

Error Code	Title	Description	Resolution
FREE_TIER_INVITE_REQUIRED	Invite code required	The beta access gate is enabled and this account has not been unlocked, so it cannot claim a free server yet	Redeem your invite code at POST /api/v1/users/me/redeem-invite, or ask an administrator to validate your account by email
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

SDK Usage

const result = await client.api.users.retrySetup({
  data: { region: "us-east-1" }
});

Activity Logs

GET /api/v1/users/auth/activity

Retrieve activity logs for the authenticated user with optional filtering by date range, HTTP method, status code, or realm.

Parameters

Name	In	Type	Required	Description
page	query	integer	No	Page number. Default: 1.
limit	query	integer	No	Results per page. Default: 50.
start_date	query	string	No	Filter logs after this date.
end_date	query	string	No	Filter logs before this date.
errors_only	query	string	No	Show only errors (status ≥ 400). Literal values: true, false.
min_status	query	integer	No	Minimum status code.
max_status	query	integer	No	Maximum status code.
method	query	string	No	Filter by HTTP method. Literal values: GET, POST, PUT, PATCH, DELETE.
realm_id	query	string	No	Filter by realm ID.

Response

200

{
  "statusCode": 200,
  "message": "Activity logs retrieved successfully",
  "data": [
    {
      "id": "1a9c3592695c087a8f35ceae",
      "user_id": "507f1f77bcf86cd799439011",
      "realm_id": "507f1f77bcf86cd799439011",
      "method": "GET",
      "path": "/api/v1/projects",
      "status_code": 200,
      "ip_address": "192.168.1.1",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
      "created_at": "2025-11-18T20:00:00Z"
    }
  ],
  "metadata": {
    "total": 100,
    "page": 1,
    "limit": 50,
    "pages": 2
  }
}

SDK Usage

const logs = await client.api.activity.listIterator({
  page: 1,
  limit: 50,
  errors_only: "true"
});

GET /api/v1/users/auth/activity/stats

Retrieve storage usage statistics for activity logs, including total size, record count, oldest/newest record timestamps, and retention period.

This endpoint takes no parameters.

Response

200

{
  "statusCode": 200,
  "message": "Activity stats retrieved successfully",
  "data": {
    "total_size_bytes": 1048576,
    "total_records": 5000,
    "oldest_record": "2025-10-18T20:00:00Z",
    "newest_record": "2025-11-18T20:00:00Z",
    "retention_days": 30
  }
}

SDK Usage

const stats = await client.api.activity.getStats();

User Vault

The user vault stores arbitrary key-value pairs scoped to a realm. Total size limits are enforced globally across all realms, while key listings and per-realm counts are scoped to the current realm.

Tip

The API does not validate or verify vault content. Encryption is highly recommended for any sensitive data such as secrets, passwords, or API keys.

GET /api/v1/vault/keys

List all keys in your encrypted vault with metadata (key names, sizes, timestamps). Values are not included — use GET /vault/keys/:key to retrieve individual values.

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.

Response

200

{
  "statusCode": 200,
  "message": "Vault keys retrieved successfully",
  "data": [
    {
      "key": "my-encrypted-notes",
      "realm_id": "507f1f77bcf86cd799439011",
      "metadata": {},
      "size_bytes": 2048,
      "created_at": "2025-11-14T18:00:00.000Z",
      "updated_at": "2025-11-14T18:15:00.000Z"
    }
  ]
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

SDK Usage

const keys = await client.api.vault.listIterator({
  realm_id: "507f1f77bcf86cd799439011"
});

GET /api/v1/vault/keys/{key}

Retrieve a specific key-value pair from your encrypted vault by key name.

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.
key	path	string	Yes	Vault key name (alphanumeric, dots, underscores, hyphens).

Response

200

{
  "statusCode": 200,
  "message": "Vault key retrieved successfully",
  "data": {
    "key": "my-encrypted-notes",
    "realm_id": "507f1f77bcf86cd799439011",
    "value": "{\"notes\": \"My important notes\", \"encrypted\": true}",
    "metadata": {},
    "size_bytes": 53,
    "created_at": "2025-11-14T18:00:00.000Z",
    "updated_at": "2025-11-14T18:15:00.000Z"
  }
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Vault key not found."
}

Error Code	Title	Description	Resolution
VAULT_KEY_NOT_FOUND	Vault Key Not Found	The specified key does not exist in your vault.	Verify the key name is correct.

SDK Usage

const entry = await client.api.vault.get({
  key: "my-encrypted-notes",
  realm_id: "507f1f77bcf86cd799439011"
});

PATCH /api/v1/vault/keys/{key}

Create or update a key-value pair in your personal encrypted vault. Values can be any UTF-8 string (JSON, encrypted data, plain text).

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.
key	path	string	Yes	Vault key name (alphanumeric, dots, underscores, hyphens).

Request Body

Field	Type	Required	Description
value	string	Yes	Value to store. Any UTF-8 string (JSON, encrypted data, plain text). Counts toward vault storage limit.
metadata	object	No	Optional JSON metadata (max 256KB). Useful for content-type, filename, upload date, etc. Counts toward vault storage limit.

Response

200

{
  "statusCode": 200,
  "message": "Vault key updated successfully",
  "data": {
    "key": "my-encrypted-notes",
    "realm_id": "507f1f77bcf86cd799439011",
    "value": "{\"notes\": \"My important notes\", \"encrypted\": true}",
    "metadata": {},
    "size_bytes": 53,
    "created_at": "2025-11-14T18:00:00.000Z",
    "updated_at": "2025-11-14T18:15:00.000Z"
  }
}

201

{
  "statusCode": 201,
  "message": "Vault key created successfully",
  "data": {
    "key": "my-encrypted-notes",
    "realm_id": "507f1f77bcf86cd799439011",
    "value": "{\"notes\": \"My important notes\", \"encrypted\": true}",
    "metadata": {},
    "size_bytes": 53,
    "created_at": "2025-11-14T18:00:00.000Z",
    "updated_at": "2025-11-14T18:00:00.000Z"
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed"
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input parameters	One or more request parameters failed validation	Check the error message for specific field requirements and correct your input

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

413

{
  "statusCode": 413,
  "error": "Payload Too Large",
  "message": "Vault storage limit exceeded."
}

Error Code	Title	Description	Resolution
VAULT_LIMIT_EXCEEDED	Vault Storage Limit Exceeded	The operation would exceed your vault storage limit.	Delete existing keys to free up space or contact support to increase your limit.

SDK Usage

await client.api.vault.set({
  key: "api-keys",
  realm_id: "507f1f77bcf86cd799439011",
  data: { value: "{\"key\": \"secret\"}" }
});

DELETE /api/v1/vault/keys/{key}

Permanently delete a key-value pair from your encrypted vault. This action cannot be undone.

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.
key	path	string	Yes	Vault key name (alphanumeric, dots, underscores, hyphens).

Response

200

{
  "statusCode": 200,
  "message": "Vault key deleted successfully"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Vault key not found."
}

Error Code	Title	Description	Resolution
VAULT_KEY_NOT_FOUND	Vault Key Not Found	The specified key does not exist in your vault.	Verify the key name is correct.

SDK Usage

await client.api.vault.delete({
  key: "api-keys",
  realm_id: "507f1f77bcf86cd799439011"
});

GET /api/v1/vault/stats

Retrieve statistics about your vault usage. total_keys and total_size_bytes are scoped to the current realm. limit_mb, remaining_mb, and used_percentage reflect global vault usage across all realms.

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.

Response

200

{
  "statusCode": 200,
  "message": "Vault statistics retrieved successfully",
  "data": {
    "total_keys": 5,
    "total_size_bytes": 10240,
    "total_size_mb": 0.009766,
    "limit_mb": 50,
    "used_percentage": 0.02,
    "remaining_mb": 49.990234
  }
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

SDK Usage

const stats = await client.api.vault.getStats({
  realm_id: "507f1f77bcf86cd799439011"
});

DELETE /api/v1/vault

Permanently delete ALL keys and values from your encrypted vault. This action cannot be undone.

Danger

This operation is irreversible. All vault entries in the targeted realm will be permanently removed.

Parameters

Name	In	Type	Required	Description
realm_id	query	string	No	Target a specific realm (24-char hex). When omitted and not on a realm subdomain, defaults to global scope (realm_id = ""). Case-insensitive — uppercase is normalized to lowercase.

Response

200

{
  "statusCode": 200,
  "message": "Vault cleared successfully",
  "data": {
    "deleted_count": 5
  }
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication token required"
}

Error Code	Title	Description	Resolution
MISSING_TOKEN	Authentication token missing	No authentication token was provided in the request	Include a valid JWT token in the Authorization header as Bearer <token>
INVALID_TOKEN	Invalid authentication token	The provided authentication token is malformed or invalid	Obtain a new token by logging in again or using a valid auth token

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions"
}

Error Code	Title	Description	Resolution
INSUFFICIENT_PERMISSIONS	Insufficient permissions	You do not have the required permissions to perform this action	Contact the resource owner or administrator to request access

SDK Usage

await client.api.vault.clear({
  realm_id: "507f1f77bcf86cd799439011"
});