{ "openapi": "3.1.0", "info": { "title": "Kaneo API", "description": "Kaneo Project Management API - Manage projects, tasks, labels, and more", "version": "1.0.0" }, "servers": [ { "url": "http://localhost:1337/api", "description": "Kaneo API Server" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Bearer token authentication" }, "apiKeyCookie": { "type": "apiKey", "in": "cookie", "name": "apiKeyCookie", "description": "API Key authentication via cookie" } }, "schemas": { "User": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean", "default": false, "readOnly": true }, "image": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "updatedAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "isAnonymous": { "type": "boolean", "default": false, "readOnly": true } }, "required": [ "name", "email", "createdAt", "updatedAt" ] }, "Session": { "type": "object", "properties": { "id": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "token": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "updatedAt": { "type": "string", "format": "date-time" }, "ipAddress": { "type": "string" }, "userAgent": { "type": "string" }, "userId": { "type": "string" }, "activeOrganizationId": { "type": "string" }, "activeTeamId": { "type": "string" } }, "required": [ "expiresAt", "token", "createdAt", "updatedAt", "userId" ] }, "Account": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "providerId": { "type": "string" }, "userId": { "type": "string" }, "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "idToken": { "type": "string" }, "accessTokenExpiresAt": { "type": "string", "format": "date-time" }, "refreshTokenExpiresAt": { "type": "string", "format": "date-time" }, "scope": { "type": "string" }, "password": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "accountId", "providerId", "userId", "createdAt", "updatedAt" ] }, "Verification": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "value": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "updatedAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" } }, "required": [ "identifier", "value", "expiresAt", "createdAt", "updatedAt" ] }, "Organization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "logo": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "metadata": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name", "slug", "createdAt" ] }, "Team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "organizationId", "createdAt" ] }, "TeamMember": { "type": "object", "properties": { "id": { "type": "string" }, "teamId": { "type": "string" }, "userId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "teamId", "userId" ] }, "Member": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "userId": { "type": "string" }, "role": { "type": "string", "default": "member" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "organizationId", "userId", "role", "createdAt" ] }, "Invitation": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "teamId": { "type": "string" }, "status": { "type": "string", "default": "pending" }, "expiresAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "default": "Generated at runtime" }, "inviterId": { "type": "string" } }, "required": [ "organizationId", "email", "status", "expiresAt", "createdAt", "inviterId" ] }, "Apikey": { "type": "object", "properties": { "id": { "type": "string" }, "configId": { "type": "string", "default": "default", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "start": { "type": "string", "readOnly": true }, "referenceId": { "type": "string", "readOnly": true }, "prefix": { "type": "string", "readOnly": true }, "key": { "type": "string", "readOnly": true }, "refillInterval": { "type": "number", "readOnly": true }, "refillAmount": { "type": "number", "readOnly": true }, "lastRefillAt": { "type": "string", "format": "date-time", "readOnly": true }, "enabled": { "type": "boolean", "default": true, "readOnly": true }, "rateLimitEnabled": { "type": "boolean", "default": true, "readOnly": true }, "rateLimitTimeWindow": { "type": "number", "default": 86400000, "readOnly": true }, "rateLimitMax": { "type": "number", "default": 10, "readOnly": true }, "requestCount": { "type": "number", "default": 0, "readOnly": true }, "remaining": { "type": "number", "readOnly": true }, "lastRequest": { "type": "string", "format": "date-time", "readOnly": true }, "expiresAt": { "type": "string", "format": "date-time", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "permissions": { "type": "string", "readOnly": true }, "metadata": { "type": "string" } } } }, "responses": { "getConfig_200_response": { "description": "Application settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "disableRegistration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isDemoMode": { "type": "boolean" }, "hasSmtp": { "type": "boolean" }, "hasGithubSignIn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "hasGoogleSignIn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "hasDiscordSignIn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "hasCustomOAuth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "hasGuestAccess": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "disableRegistration", "isDemoMode", "hasSmtp", "hasGithubSignIn", "hasGoogleSignIn", "hasDiscordSignIn", "hasCustomOAuth", "hasGuestAccess" ] } } } }, "listProjects_200_response": { "description": "List of projects with statistics", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } } } } }, "createProject_200_response": { "description": "Project created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } } } }, "getProject_200_response": { "description": "Project details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } } } }, "updateProject_200_response": { "description": "Project updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } } } }, "deleteProject_200_response": { "description": "Project deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } } } }, "listTasks_200_response": { "description": "Project with tasks organized by columns", "content": { "application/json": { "schema": {} } } }, "createTask_200_response": { "description": "Task created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "getTask_200_response": { "description": "Task details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTask_200_response": { "description": "Task updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "deleteTask_200_response": { "description": "Task deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "exportTasks_200_response": { "description": "Exported tasks data", "content": { "application/json": { "schema": {} } } }, "importTasks_200_response": { "description": "Tasks imported successfully", "content": { "application/json": { "schema": {} } } }, "updateTaskStatus_200_response": { "description": "Task status updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTaskPriority_200_response": { "description": "Task priority updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTaskAssignee_200_response": { "description": "Task assignee updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTaskDueDate_200_response": { "description": "Task due date updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTaskTitle_200_response": { "description": "Task title updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "updateTaskDescription_200_response": { "description": "Task description updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } } } }, "getColumns_200_response": { "description": "List of columns ordered by position", "content": { "application/json": { "schema": {} } } }, "createColumn_200_response": { "description": "Column created successfully", "content": { "application/json": { "schema": {} } } }, "reorderColumns_200_response": { "description": "Columns reordered successfully", "content": { "application/json": { "schema": {} } } }, "updateColumn_200_response": { "description": "Column updated successfully", "content": { "application/json": { "schema": {} } } }, "deleteColumn_200_response": { "description": "Column deleted successfully", "content": { "application/json": { "schema": {} } } }, "getActivities_200_response": { "description": "List of activities for the task", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } } } }, "createActivity_200_response": { "description": "Activity created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } } }, "updateComment_200_response": { "description": "Comment updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } } }, "createComment_200_response": { "description": "Comment created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } } }, "deleteComment_200_response": { "description": "Comment deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } } }, "getTaskTimeEntries_200_response": { "description": "List of time entries for the task", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startTime": {}, "endTime": {}, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": {} }, "required": [ "id", "taskId", "userId", "description", "startTime", "duration", "createdAt" ] } } } } }, "getTimeEntry_200_response": { "description": "Time entry details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startTime": {}, "endTime": {}, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": {} }, "required": [ "id", "taskId", "userId", "description", "startTime", "duration", "createdAt" ] } } } }, "updateTimeEntry_200_response": { "description": "Time entry updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startTime": {}, "endTime": {}, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": {} }, "required": [ "id", "taskId", "userId", "description", "startTime", "duration", "createdAt" ] } } } }, "createTimeEntry_200_response": { "description": "Time entry created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startTime": {}, "endTime": {}, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": {} }, "required": [ "id", "taskId", "userId", "description", "startTime", "duration", "createdAt" ] } } } }, "getTaskLabels_200_response": { "description": "List of labels for the task", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } } }, "getWorkspaceLabels_200_response": { "description": "List of labels in the workspace", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } } }, "createLabel_200_response": { "description": "Label created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } }, "getLabel_200_response": { "description": "Label details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } }, "updateLabel_200_response": { "description": "Label updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } }, "deleteLabel_200_response": { "description": "Label deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": {}, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "color", "createdAt", "taskId", "workspaceId" ] } } } }, "listNotifications_200_response": { "description": "List of notifications", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "title": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "info", "task_created", "workspace_created", "task_status_changed", "task_assignee_changed", "time_entry_created" ] }, "isRead": { "type": "boolean" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "task", "workspace" ] }, "createdAt": {} }, "required": [ "id", "userId", "title", "content", "type", "createdAt" ] } } } } }, "createNotification_200_response": { "description": "Notification created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "title": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "info", "task_created", "workspace_created", "task_status_changed", "task_assignee_changed", "time_entry_created" ] }, "isRead": { "type": "boolean" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "task", "workspace" ] }, "createdAt": {} }, "required": [ "id", "userId", "title", "content", "type", "createdAt" ] } } } }, "markNotificationAsRead_200_response": { "description": "Notification marked as read", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "title": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "info", "task_created", "workspace_created", "task_status_changed", "task_assignee_changed", "time_entry_created" ] }, "isRead": { "type": "boolean" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "task", "workspace" ] }, "createdAt": {} }, "required": [ "id", "userId", "title", "content", "type", "createdAt" ] } } } }, "markAllNotificationsAsRead_200_response": { "description": "All notifications marked as read", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "number" } }, "required": [ "success" ] } } } }, "clearAllNotifications_200_response": { "description": "All notifications cleared", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "number" } }, "required": [ "success" ] } } } }, "globalSearch_200_response": { "description": "Search results", "content": { "application/json": { "schema": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "priority": { "enum": [ "no-priority", "low", "medium", "high", "urgent" ] }, "dueDate": {}, "createdAt": {} }, "required": [ "id", "projectId", "position", "number", "userId", "title", "description", "status", "priority", "createdAt" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "slug": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {}, "isPublic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "slug", "icon", "name", "description", "createdAt", "isPublic" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": {} }, "required": [ "id", "name", "slug", "logo", "metadata", "description", "createdAt" ] } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } }, "activities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "comment", "task", "status_changed", "priority_changed", "unassigned", "assignee_changed", "due_date_changed", "title_changed", "description_changed", "create" ] }, "createdAt": {}, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUserAvatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "externalUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "taskId", "type", "createdAt", "userId", "content", "externalUserName", "externalUserAvatar", "externalSource", "externalUrl" ] } } }, "required": [] } } } }, "getGitHubAppInfo_200_response": { "description": "GitHub app information", "content": { "application/json": { "schema": { "type": "object", "properties": { "appName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "appName" ] } } } }, "listGitHubRepositories_200_response": { "description": "List of repositories", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" } }, "required": [ "login" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string" } }, "required": [ "id", "name", "full_name", "owner", "private", "html_url" ] } } } } }, "verifyGitHubInstallation_200_response": { "description": "Verification result", "content": { "application/json": { "schema": { "type": "object", "properties": { "installed": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "installed" ] } } } }, "getGitHubIntegration_200_response": { "description": "GitHub integration details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "repositoryOwner": { "type": "string" }, "repositoryName": { "type": "string" }, "installationId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "projectId", "repositoryOwner", "repositoryName", "installationId", "isActive", "createdAt", "updatedAt" ] } } } }, "createGitHubIntegration_200_response": { "description": "Integration created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "repositoryOwner": { "type": "string" }, "repositoryName": { "type": "string" }, "installationId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "projectId", "repositoryOwner", "repositoryName", "installationId", "isActive", "createdAt", "updatedAt" ] } } } }, "deleteGitHubIntegration_200_response": { "description": "Integration deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "repositoryOwner": { "type": "string" }, "repositoryName": { "type": "string" }, "installationId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "projectId", "repositoryOwner", "repositoryName", "installationId", "isActive", "createdAt", "updatedAt" ] } } } }, "updateGitHubIntegration_200_response": { "description": "Integration updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "repositoryOwner": { "type": "string" }, "repositoryName": { "type": "string" }, "installationId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "projectId", "repositoryOwner", "repositoryName", "installationId", "isActive", "createdAt", "updatedAt" ] } } } }, "updateGitHubIntegration_404_response": { "description": "Integration not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "importGitHubIssues_200_response": { "description": "Issues imported successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "imported": { "type": "number" }, "skipped": { "type": "number" }, "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "imported", "skipped" ] } } } }, "getExternalLinksByTask_200_response": { "description": "External links for the task", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "taskId": { "type": "string" }, "integrationId": { "type": "string" }, "resourceType": { "type": "string" }, "externalId": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": {}, "createdAt": {}, "updatedAt": {} }, "required": [ "id", "taskId", "integrationId", "resourceType", "externalId", "url", "title", "metadata", "createdAt", "updatedAt" ] } } } } }, "getWorkflowRules_200_response": { "description": "List of workflow rules", "content": { "application/json": { "schema": {} } } }, "upsertWorkflowRule_200_response": { "description": "Workflow rule upserted successfully", "content": { "application/json": { "schema": {} } } }, "deleteWorkflowRule_200_response": { "description": "Workflow rule deleted successfully", "content": { "application/json": { "schema": {} } } }, "getUserPendingInvitations_200_response": { "description": "List of pending invitations", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "workspaceId": { "type": "string" }, "workspaceName": { "type": "string" }, "inviterName": { "type": "string" }, "expiresAt": { "type": "string" }, "createdAt": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "email", "workspaceId", "workspaceName", "inviterName", "expiresAt", "createdAt", "status" ] } } } } }, "getInvitationDetails_200_response": { "description": "Invitation details", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "invitation": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "workspaceName": { "type": "string" }, "inviterName": { "type": "string" }, "expiresAt": { "type": "string" }, "status": { "type": "string" }, "expired": { "type": "boolean" } }, "required": [ "id", "email", "workspaceName", "inviterName", "expiresAt", "status", "expired" ] }, "error": { "type": "string" } }, "required": [ "valid" ] } } } }, "socialSignIn_200_response": { "description": "Success - Returns either session details or redirect URL", "content": { "application/json": { "schema": { "type": "object", "description": "Session response when idToken is provided", "properties": { "token": { "type": "string" }, "user": { "type": "object", "$ref": "#/components/schemas/User" }, "url": { "type": "string" }, "redirect": { "type": "boolean", "enum": [ false ] } }, "required": [ "redirect", "token", "user" ] } } } }, "socialSignIn_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "socialSignIn_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "socialSignIn_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "socialSignIn_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "socialSignIn_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "socialSignIn_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_callback_id_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_callback_id_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_callback_id_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_callback_id_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_callback_id_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_callback_id_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_callback_id_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_callback_id_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_callback_id_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_callback_id_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_callback_id_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_callback_id_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "getSession_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "nullable": true, "properties": { "session": { "$ref": "#/components/schemas/Session" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "session", "user" ] } } } }, "getSession_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "getSession_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "getSession_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "getSession_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "getSession_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "getSession_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "getSession_post_get_session_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "nullable": true, "properties": { "session": { "$ref": "#/components/schemas/Session" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "session", "user" ] } } } }, "getSession_post_get_session_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "getSession_post_get_session_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "getSession_post_get_session_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "getSession_post_get_session_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "getSession_post_get_session_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "getSession_post_get_session_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "signOut_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "signOut_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "signOut_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "signOut_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "signOut_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "signOut_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "signOut_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "signUpWithEmailAndPassword_200_response": { "description": "Successfully created user", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "nullable": true, "description": "Authentication token for the session" }, "user": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user" }, "email": { "type": "string", "format": "email", "description": "The email address of the user" }, "name": { "type": "string", "description": "The name of the user" }, "image": { "type": "string", "format": "uri", "nullable": true, "description": "The profile image URL of the user" }, "emailVerified": { "type": "boolean", "description": "Whether the email has been verified" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the user was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the user was last updated" } }, "required": [ "id", "email", "name", "emailVerified", "createdAt", "updatedAt" ] } }, "required": [ "user" ] } } } }, "signUpWithEmailAndPassword_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "signUpWithEmailAndPassword_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "signUpWithEmailAndPassword_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "signUpWithEmailAndPassword_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "signUpWithEmailAndPassword_422_response": { "description": "Unprocessable Entity. User already exists or failed to create user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "signUpWithEmailAndPassword_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "signUpWithEmailAndPassword_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "signInEmail_200_response": { "description": "Success - Returns either session details or redirect URL", "content": { "application/json": { "schema": { "type": "object", "description": "Session response when idToken is provided", "properties": { "redirect": { "type": "boolean", "enum": [ false ] }, "token": { "type": "string", "description": "Session token" }, "url": { "type": "string", "nullable": true }, "user": { "type": "object", "$ref": "#/components/schemas/User" } }, "required": [ "redirect", "token", "user" ] } } } }, "signInEmail_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "signInEmail_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "signInEmail_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "signInEmail_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "signInEmail_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "signInEmail_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "resetPassword_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" } } } } } }, "resetPassword_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "resetPassword_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "resetPassword_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "resetPassword_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "resetPassword_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "resetPassword_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "verifyPassword_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" } } } } } }, "verifyPassword_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "verifyPassword_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "verifyPassword_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "verifyPassword_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "verifyPassword_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "verifyPassword_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_verify_email_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "$ref": "#/components/schemas/User" }, "status": { "type": "boolean", "description": "Indicates if the email was verified successfully" } }, "required": [ "user", "status" ] } } } }, "get_verify_email_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_verify_email_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_verify_email_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_verify_email_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_verify_email_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_verify_email_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "sendVerificationEmail_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Indicates if the email was sent successfully", "example": true } } } } } }, "sendVerificationEmail_400_response": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message", "example": "Verification email isn't enabled" } } } } } }, "sendVerificationEmail_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "sendVerificationEmail_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "sendVerificationEmail_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "sendVerificationEmail_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "sendVerificationEmail_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "changeEmail_200_response": { "description": "Email change request processed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "$ref": "#/components/schemas/User" }, "status": { "type": "boolean", "description": "Indicates if the request was successful" }, "message": { "type": "string", "enum": [ "Email updated", "Verification email sent" ], "description": "Status message of the email change process", "nullable": true } }, "required": [ "status" ] } } } }, "changeEmail_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "changeEmail_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "changeEmail_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "changeEmail_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "changeEmail_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "changeEmail_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "changePassword_200_response": { "description": "Password successfully changed", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "nullable": true, "description": "New session token if other sessions were revoked" }, "user": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user" }, "email": { "type": "string", "format": "email", "description": "The email address of the user" }, "name": { "type": "string", "description": "The name of the user" }, "image": { "type": "string", "format": "uri", "nullable": true, "description": "The profile image URL of the user" }, "emailVerified": { "type": "boolean", "description": "Whether the email has been verified" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the user was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the user was last updated" } }, "required": [ "id", "email", "name", "emailVerified", "createdAt", "updatedAt" ] } }, "required": [ "user" ] } } } }, "changePassword_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "changePassword_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "changePassword_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "changePassword_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "changePassword_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "changePassword_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "updateSession_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "object", "$ref": "#/components/schemas/Session" } } } } } }, "updateSession_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "updateSession_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "updateSession_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "updateSession_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "updateSession_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "updateSession_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "updateUser_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "$ref": "#/components/schemas/User" } } } } } }, "updateUser_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "updateUser_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "updateUser_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "updateUser_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "updateUser_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "updateUser_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "deleteUser_200_response": { "description": "User deletion processed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the operation was successful" }, "message": { "type": "string", "enum": [ "User deleted", "Verification email sent" ], "description": "Status message of the deletion process" } }, "required": [ "success", "message" ] } } } }, "deleteUser_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "deleteUser_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "deleteUser_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "deleteUser_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "deleteUser_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "deleteUser_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "requestPasswordReset_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "type": "string" } } } } } }, "requestPasswordReset_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "requestPasswordReset_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "requestPasswordReset_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "requestPasswordReset_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "requestPasswordReset_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "requestPasswordReset_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "resetPasswordCallback_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } }, "resetPasswordCallback_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "resetPasswordCallback_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "resetPasswordCallback_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "resetPasswordCallback_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "resetPasswordCallback_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "resetPasswordCallback_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "listUserSessions_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Session" } } } } }, "listUserSessions_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "listUserSessions_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "listUserSessions_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "listUserSessions_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "listUserSessions_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "listUserSessions_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_revoke_session_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Indicates if the session was revoked successfully" } }, "required": [ "status" ] } } } }, "post_revoke_session_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_revoke_session_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_revoke_session_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_revoke_session_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_revoke_session_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_revoke_session_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_revoke_sessions_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Indicates if all sessions were revoked successfully" } }, "required": [ "status" ] } } } }, "post_revoke_sessions_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_revoke_sessions_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_revoke_sessions_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_revoke_sessions_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_revoke_sessions_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_revoke_sessions_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_revoke_other_sessions_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Indicates if all other sessions were revoked successfully" } }, "required": [ "status" ] } } } }, "post_revoke_other_sessions_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_revoke_other_sessions_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_revoke_other_sessions_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_revoke_other_sessions_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_revoke_other_sessions_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_revoke_other_sessions_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "linkSocialAccount_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "The authorization URL to redirect the user to" }, "redirect": { "type": "boolean", "description": "Indicates if the user should be redirected to the authorization URL" }, "status": { "type": "boolean" } }, "required": [ "redirect" ] } } } }, "linkSocialAccount_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "linkSocialAccount_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "linkSocialAccount_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "linkSocialAccount_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "linkSocialAccount_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "linkSocialAccount_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "listUserAccounts_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "providerId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "accountId": { "type": "string" }, "userId": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "providerId", "createdAt", "updatedAt", "accountId", "userId", "scopes" ] } } } } }, "listUserAccounts_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "listUserAccounts_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "listUserAccounts_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "listUserAccounts_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "listUserAccounts_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "listUserAccounts_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_delete_user_callback_200_response": { "description": "User successfully deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the deletion was successful" }, "message": { "type": "string", "enum": [ "User deleted" ], "description": "Confirmation message" } }, "required": [ "success", "message" ] } } } }, "get_delete_user_callback_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_delete_user_callback_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_delete_user_callback_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_delete_user_callback_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_delete_user_callback_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_delete_user_callback_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_unlink_account_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" } } } } } }, "post_unlink_account_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_unlink_account_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_unlink_account_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_unlink_account_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_unlink_account_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_unlink_account_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_refresh_token_200_response": { "description": "Access token refreshed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "tokenType": { "type": "string" }, "idToken": { "type": "string" }, "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "accessTokenExpiresAt": { "type": "string", "format": "date-time" }, "refreshTokenExpiresAt": { "type": "string", "format": "date-time" } } } } } }, "post_refresh_token_400_response": { "description": "Invalid refresh token or provider configuration" }, "post_refresh_token_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_refresh_token_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_refresh_token_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_refresh_token_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_refresh_token_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_get_access_token_200_response": { "description": "A Valid access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "tokenType": { "type": "string" }, "idToken": { "type": "string" }, "accessToken": { "type": "string" }, "accessTokenExpiresAt": { "type": "string", "format": "date-time" } } } } } }, "post_get_access_token_400_response": { "description": "Invalid refresh token or provider configuration" }, "post_get_access_token_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_get_access_token_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_get_access_token_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_get_access_token_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_get_access_token_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_account_info_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "image": { "type": "string" }, "emailVerified": { "type": "boolean" } }, "required": [ "id", "emailVerified" ] }, "data": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "user", "data" ], "additionalProperties": false } } } }, "get_account_info_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_account_info_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_account_info_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_account_info_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_account_info_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_account_info_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_ok_200_response": { "description": "API is working", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "Indicates if the API is working" } }, "required": [ "ok" ] } } } }, "get_ok_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_ok_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_ok_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_ok_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_ok_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_ok_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_error_200_response": { "description": "Success", "content": { "text/html": { "schema": { "type": "string", "description": "The HTML content of the error page" } } } }, "get_error_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_error_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_error_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_error_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_error_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_error_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_sign_in_anonymous_200_response": { "description": "Sign in anonymously", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "session": { "$ref": "#/components/schemas/Session" } } } } } }, "post_sign_in_anonymous_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_sign_in_anonymous_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_sign_in_anonymous_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_sign_in_anonymous_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_sign_in_anonymous_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_sign_in_anonymous_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_delete_anonymous_user_200_response": { "description": "Anonymous user deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "post_delete_anonymous_user_400_response": { "description": "Anonymous user deletion is disabled", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "post_delete_anonymous_user_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_delete_anonymous_user_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_delete_anonymous_user_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_delete_anonymous_user_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_delete_anonymous_user_500_response": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "signInWithMagicLink_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" } } } } } }, "signInWithMagicLink_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "signInWithMagicLink_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "signInWithMagicLink_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "signInWithMagicLink_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "signInWithMagicLink_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "signInWithMagicLink_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "verifyMagicLink_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/Session" }, "user": { "$ref": "#/components/schemas/User" } } } } } }, "verifyMagicLink_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "verifyMagicLink_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "verifyMagicLink_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "verifyMagicLink_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "verifyMagicLink_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "verifyMagicLink_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "sendEmailVerificationOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "sendEmailVerificationOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "sendEmailVerificationOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "sendEmailVerificationOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "sendEmailVerificationOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "sendEmailVerificationOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "sendEmailVerificationOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "verifyEmailWithOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "verifyEmailWithOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "verifyEmailWithOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "verifyEmailWithOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "verifyEmailWithOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "verifyEmailWithOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "verifyEmailWithOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_email_otp_verify_email_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Indicates if the verification was successful", "enum": [ true ] }, "token": { "type": "string", "nullable": true, "description": "Session token if autoSignInAfterVerification is enabled, otherwise null" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "status", "token", "user" ] } } } }, "post_email_otp_verify_email_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_email_otp_verify_email_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_email_otp_verify_email_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_email_otp_verify_email_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_email_otp_verify_email_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_email_otp_verify_email_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "signInWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Session token for the authenticated session" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "token", "user" ] } } } }, "signInWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "signInWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "signInWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "signInWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "signInWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "signInWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "requestPasswordResetWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the OTP was sent successfully" } } } } } }, "requestPasswordResetWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "requestPasswordResetWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "requestPasswordResetWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "requestPasswordResetWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "requestPasswordResetWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "requestPasswordResetWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "forgetPasswordWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the OTP was sent successfully" } } } } } }, "forgetPasswordWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "forgetPasswordWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "forgetPasswordWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "forgetPasswordWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "forgetPasswordWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "forgetPasswordWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "resetPasswordWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "resetPasswordWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "resetPasswordWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "resetPasswordWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "resetPasswordWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "resetPasswordWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "resetPasswordWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "requestEmailChangeWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "requestEmailChangeWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "requestEmailChangeWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "requestEmailChangeWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "requestEmailChangeWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "requestEmailChangeWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "requestEmailChangeWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "changeEmailWithEmailOTP_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "changeEmailWithEmailOTP_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "changeEmailWithEmailOTP_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "changeEmailWithEmailOTP_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "changeEmailWithEmailOTP_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "changeEmailWithEmailOTP_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "changeEmailWithEmailOTP_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_create_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "The organization that was created", "$ref": "#/components/schemas/Organization" } } } }, "post_organization_create_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_create_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_create_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_create_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_create_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_create_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_update_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "The updated organization", "$ref": "#/components/schemas/Organization" } } } }, "post_organization_update_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_update_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_update_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_update_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_update_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_update_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_delete_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "description": "The organization id that was deleted" } } } }, "post_organization_delete_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_delete_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_delete_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_delete_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_delete_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_delete_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "setActiveOrganization_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "The organization", "$ref": "#/components/schemas/Organization" } } } }, "setActiveOrganization_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "setActiveOrganization_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "setActiveOrganization_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "setActiveOrganization_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "setActiveOrganization_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "setActiveOrganization_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "getOrganization_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "The organization", "$ref": "#/components/schemas/Organization" } } } }, "getOrganization_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "getOrganization_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "getOrganization_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "getOrganization_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "getOrganization_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "getOrganization_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "get_organization_list_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "createOrganizationInvitation_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "organizationId": { "type": "string" }, "inviterId": { "type": "string" }, "status": { "type": "string" }, "expiresAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "email", "role", "organizationId", "inviterId", "status", "expiresAt", "createdAt" ] } } } }, "createOrganizationInvitation_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "createOrganizationInvitation_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "createOrganizationInvitation_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "createOrganizationInvitation_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "createOrganizationInvitation_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "createOrganizationInvitation_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_cancel_invitation_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_cancel_invitation_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_cancel_invitation_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_cancel_invitation_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_cancel_invitation_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_cancel_invitation_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_accept_invitation_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "object" }, "member": { "type": "object" } } } } } }, "post_organization_accept_invitation_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_accept_invitation_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_accept_invitation_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_accept_invitation_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_accept_invitation_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_accept_invitation_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_get_invitation_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "organizationId": { "type": "string" }, "inviterId": { "type": "string" }, "status": { "type": "string" }, "expiresAt": { "type": "string" }, "organizationName": { "type": "string" }, "organizationSlug": { "type": "string" }, "inviterEmail": { "type": "string" } }, "required": [ "id", "email", "role", "organizationId", "inviterId", "status", "expiresAt", "organizationName", "organizationSlug", "inviterEmail" ] } } } }, "get_organization_get_invitation_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_get_invitation_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_get_invitation_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_get_invitation_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_get_invitation_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_get_invitation_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_reject_invitation_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "object" }, "member": { "type": "object", "nullable": true } } } } } }, "post_organization_reject_invitation_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_reject_invitation_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_reject_invitation_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_reject_invitation_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_reject_invitation_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_reject_invitation_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_invitations_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_invitations_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_invitations_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_invitations_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_invitations_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_invitations_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_get_active_member_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "role": { "type": "string" } }, "required": [ "id", "userId", "organizationId", "role" ] } } } }, "get_organization_get_active_member_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_get_active_member_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_get_active_member_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_get_active_member_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_get_active_member_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_get_active_member_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_check_slug_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_check_slug_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_check_slug_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_check_slug_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_check_slug_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_check_slug_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_remove_member_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "member": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "role": { "type": "string" } }, "required": [ "id", "userId", "organizationId", "role" ] } }, "required": [ "member" ] } } } }, "post_organization_remove_member_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_remove_member_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_remove_member_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_remove_member_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_remove_member_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_remove_member_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "updateOrganizationMemberRole_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "member": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "role": { "type": "string" } }, "required": [ "id", "userId", "organizationId", "role" ] } }, "required": [ "member" ] } } } }, "updateOrganizationMemberRole_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "updateOrganizationMemberRole_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "updateOrganizationMemberRole_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "updateOrganizationMemberRole_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "updateOrganizationMemberRole_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "updateOrganizationMemberRole_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_leave_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_leave_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_leave_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_leave_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_leave_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_leave_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_user_invitations_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "inviterId": { "type": "string", "description": "The ID of the user who created the invitation" }, "teamId": { "type": "string", "description": "The ID of the team associated with the invitation", "nullable": true }, "status": { "type": "string" }, "expiresAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "email", "role", "organizationId", "organizationName", "inviterId", "status", "expiresAt", "createdAt" ] } } } } }, "get_organization_list_user_invitations_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_user_invitations_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_user_invitations_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_user_invitations_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_user_invitations_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_user_invitations_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_members_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_members_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_members_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_members_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_members_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_members_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_get_active_member_role_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_get_active_member_role_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_get_active_member_role_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_get_active_member_role_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_get_active_member_role_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_get_active_member_role_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_create_team_200_response": { "description": "Team created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the created team" }, "name": { "type": "string", "description": "Name of the team" }, "organizationId": { "type": "string", "description": "ID of the organization the team belongs to" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was last updated" } }, "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ] } } } }, "post_organization_create_team_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_create_team_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_create_team_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_create_team_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_create_team_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_create_team_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_teams_200_response": { "description": "Teams retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the team" }, "name": { "type": "string", "description": "Name of the team" }, "organizationId": { "type": "string", "description": "ID of the organization the team belongs to" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was last updated" } }, "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ] }, "description": "Array of team objects within the organization" } } } }, "get_organization_list_teams_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_teams_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_teams_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_teams_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_teams_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_teams_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_remove_team_200_response": { "description": "Team removed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Confirmation message indicating successful removal", "enum": [ "Team removed successfully." ] } }, "required": [ "message" ] } } } }, "post_organization_remove_team_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_remove_team_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_remove_team_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_remove_team_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_remove_team_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_remove_team_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_update_team_200_response": { "description": "Team updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the updated team" }, "name": { "type": "string", "description": "Updated name of the team" }, "organizationId": { "type": "string", "description": "ID of the organization the team belongs to" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team was last updated" } }, "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ] } } } }, "post_organization_update_team_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_update_team_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_update_team_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_update_team_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_update_team_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_update_team_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_set_active_team_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "The team", "$ref": "#/components/schemas/Team" } } } }, "post_organization_set_active_team_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_set_active_team_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_set_active_team_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_set_active_team_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_set_active_team_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_set_active_team_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_user_teams_200_response": { "description": "Teams retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "The team", "$ref": "#/components/schemas/Team" }, "description": "Array of team objects within the organization" } } } }, "get_organization_list_user_teams_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_user_teams_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_user_teams_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_user_teams_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_user_teams_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_user_teams_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_organization_list_team_members_200_response": { "description": "Teams retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "The team member", "properties": { "id": { "type": "string", "description": "Unique identifier of the team member" }, "userId": { "type": "string", "description": "The user ID of the team member" }, "teamId": { "type": "string", "description": "The team ID of the team the team member is in" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team member was created" } }, "required": [ "id", "userId", "teamId", "createdAt" ] }, "description": "Array of team member objects within the team" } } } }, "get_organization_list_team_members_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_organization_list_team_members_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_organization_list_team_members_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_organization_list_team_members_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_organization_list_team_members_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_organization_list_team_members_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_add_team_member_200_response": { "description": "Team member created successfully", "content": { "application/json": { "schema": { "type": "object", "description": "The team member", "properties": { "id": { "type": "string", "description": "Unique identifier of the team member" }, "userId": { "type": "string", "description": "The user ID of the team member" }, "teamId": { "type": "string", "description": "The team ID of the team the team member is in" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the team member was created" } }, "required": [ "id", "userId", "teamId", "createdAt" ] } } } }, "post_organization_add_team_member_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_add_team_member_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_add_team_member_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_add_team_member_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_add_team_member_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_add_team_member_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_remove_team_member_200_response": { "description": "Team member removed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Confirmation message indicating successful removal", "enum": [ "Team member removed successfully." ] } }, "required": [ "message" ] } } } }, "post_organization_remove_team_member_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_remove_team_member_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_remove_team_member_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_remove_team_member_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_remove_team_member_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_remove_team_member_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_organization_has_permission_200_response": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "post_organization_has_permission_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_organization_has_permission_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_organization_has_permission_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_organization_has_permission_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_organization_has_permission_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_organization_has_permission_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_sign_in_oauth2_200_response": { "description": "Sign in with OAuth2", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "redirect": { "type": "boolean" } } } } } }, "post_sign_in_oauth2_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_sign_in_oauth2_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_sign_in_oauth2_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_sign_in_oauth2_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_sign_in_oauth2_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_sign_in_oauth2_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_oauth2_callback_providerId_200_response": { "description": "OAuth2 callback", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "get_oauth2_callback_providerId_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_oauth2_callback_providerId_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_oauth2_callback_providerId_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_oauth2_callback_providerId_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_oauth2_callback_providerId_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_oauth2_callback_providerId_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_oauth2_link_200_response": { "description": "Authorization URL generated successfully for linking an OAuth2 account", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "The authorization URL to redirect the user to for linking the OAuth2 account" }, "redirect": { "type": "boolean", "description": "Indicates that the client should redirect to the provided URL", "enum": [ true ] } }, "required": [ "url", "redirect" ] } } } }, "post_oauth2_link_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_oauth2_link_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_oauth2_link_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_oauth2_link_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_oauth2_link_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_oauth2_link_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_api_key_create_200_response": { "description": "API key created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the API key" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp" }, "name": { "type": "string", "nullable": true, "description": "Name of the API key" }, "prefix": { "type": "string", "nullable": true, "description": "Prefix of the API key" }, "start": { "type": "string", "nullable": true, "description": "Starting characters of the key (if configured)" }, "key": { "type": "string", "description": "The full API key (only returned on creation)" }, "enabled": { "type": "boolean", "description": "Whether the key is enabled" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiration timestamp" }, "referenceId": { "type": "string", "description": "ID of the reference owning the key" }, "lastRefillAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Last refill timestamp" }, "lastRequest": { "type": "string", "format": "date-time", "nullable": true, "description": "Last request timestamp" }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Metadata associated with the key" }, "rateLimitMax": { "type": "number", "nullable": true, "description": "Maximum requests in time window" }, "rateLimitTimeWindow": { "type": "number", "nullable": true, "description": "Rate limit time window in milliseconds" }, "remaining": { "type": "number", "nullable": true, "description": "Remaining requests" }, "refillAmount": { "type": "number", "nullable": true, "description": "Amount to refill" }, "refillInterval": { "type": "number", "nullable": true, "description": "Refill interval in milliseconds" }, "rateLimitEnabled": { "type": "boolean", "description": "Whether rate limiting is enabled" }, "requestCount": { "type": "number", "description": "Current request count in window" }, "permissions": { "type": "object", "nullable": true, "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Permissions associated with the key" } }, "required": [ "id", "createdAt", "updatedAt", "key", "enabled", "referenceId", "rateLimitEnabled", "requestCount" ] } } } }, "post_api_key_create_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_api_key_create_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_api_key_create_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_api_key_create_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_api_key_create_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_api_key_create_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_api_key_get_200_response": { "description": "API key retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "nullable": true, "description": "The name of the key" }, "start": { "type": "string", "nullable": true, "description": "Shows the first few characters of the API key, including the prefix. This allows you to show those few characters in the UI to make it easier for users to identify the API key." }, "prefix": { "type": "string", "nullable": true, "description": "The API Key prefix. Stored as plain text." }, "userId": { "type": "string", "description": "The owner of the user id" }, "refillInterval": { "type": "number", "nullable": true, "description": "The interval in milliseconds between refills of the `remaining` count. Example: 3600000 // refill every hour (3600000ms = 1h)" }, "refillAmount": { "type": "number", "nullable": true, "description": "The amount to refill" }, "lastRefillAt": { "type": "string", "format": "date-time", "nullable": true, "description": "The last refill date" }, "enabled": { "type": "boolean", "description": "Sets if key is enabled or disabled", "default": true }, "rateLimitEnabled": { "type": "boolean", "description": "Whether the key has rate limiting enabled" }, "rateLimitTimeWindow": { "type": "number", "nullable": true, "description": "The duration in milliseconds" }, "rateLimitMax": { "type": "number", "nullable": true, "description": "Maximum amount of requests allowed within a window" }, "requestCount": { "type": "number", "description": "The number of requests made within the rate limit time window" }, "remaining": { "type": "number", "nullable": true, "description": "Remaining requests (every time api key is used this should updated and should be updated on refill as well)" }, "lastRequest": { "type": "string", "format": "date-time", "nullable": true, "description": "When last request occurred" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiry date of a key" }, "createdAt": { "type": "string", "format": "date-time", "description": "created at" }, "updatedAt": { "type": "string", "format": "date-time", "description": "updated at" }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Extra metadata about the apiKey" }, "permissions": { "type": "string", "nullable": true, "description": "Permissions for the api key (stored as JSON string)" } }, "required": [ "id", "userId", "enabled", "rateLimitEnabled", "requestCount", "createdAt", "updatedAt" ] } } } }, "get_api_key_get_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_api_key_get_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_api_key_get_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_api_key_get_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_api_key_get_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_api_key_get_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_api_key_update_200_response": { "description": "API key updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "nullable": true, "description": "The name of the key" }, "start": { "type": "string", "nullable": true, "description": "Shows the first few characters of the API key, including the prefix. This allows you to show those few characters in the UI to make it easier for users to identify the API key." }, "prefix": { "type": "string", "nullable": true, "description": "The API Key prefix. Stored as plain text." }, "userId": { "type": "string", "description": "The owner of the user id" }, "refillInterval": { "type": "number", "nullable": true, "description": "The interval in milliseconds between refills of the `remaining` count. Example: 3600000 // refill every hour (3600000ms = 1h)" }, "refillAmount": { "type": "number", "nullable": true, "description": "The amount to refill" }, "lastRefillAt": { "type": "string", "format": "date-time", "nullable": true, "description": "The last refill date" }, "enabled": { "type": "boolean", "description": "Sets if key is enabled or disabled", "default": true }, "rateLimitEnabled": { "type": "boolean", "description": "Whether the key has rate limiting enabled" }, "rateLimitTimeWindow": { "type": "number", "nullable": true, "description": "The duration in milliseconds" }, "rateLimitMax": { "type": "number", "nullable": true, "description": "Maximum amount of requests allowed within a window" }, "requestCount": { "type": "number", "description": "The number of requests made within the rate limit time window" }, "remaining": { "type": "number", "nullable": true, "description": "Remaining requests (every time api key is used this should updated and should be updated on refill as well)" }, "lastRequest": { "type": "string", "format": "date-time", "nullable": true, "description": "When last request occurred" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiry date of a key" }, "createdAt": { "type": "string", "format": "date-time", "description": "created at" }, "updatedAt": { "type": "string", "format": "date-time", "description": "updated at" }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Extra metadata about the apiKey" }, "permissions": { "type": "string", "nullable": true, "description": "Permissions for the api key (stored as JSON string)" } }, "required": [ "id", "userId", "enabled", "rateLimitEnabled", "requestCount", "createdAt", "updatedAt" ] } } } }, "post_api_key_update_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_api_key_update_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_api_key_update_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_api_key_update_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_api_key_update_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_api_key_update_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "post_api_key_delete_200_response": { "description": "API key deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the API key was successfully deleted" } }, "required": [ "success" ] } } } }, "post_api_key_delete_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "post_api_key_delete_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "post_api_key_delete_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "post_api_key_delete_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "post_api_key_delete_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "post_api_key_delete_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." }, "get_api_key_list_200_response": { "description": "API keys retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "nullable": true, "description": "The name of the key" }, "start": { "type": "string", "nullable": true, "description": "Shows the first few characters of the API key, including the prefix. This allows you to show those few characters in the UI to make it easier for users to identify the API key." }, "prefix": { "type": "string", "nullable": true, "description": "The API Key prefix. Stored as plain text." }, "userId": { "type": "string", "description": "The owner of the user id" }, "refillInterval": { "type": "number", "nullable": true, "description": "The interval in milliseconds between refills of the `remaining` count. Example: 3600000 // refill every hour (3600000ms = 1h)" }, "refillAmount": { "type": "number", "nullable": true, "description": "The amount to refill" }, "lastRefillAt": { "type": "string", "format": "date-time", "nullable": true, "description": "The last refill date" }, "enabled": { "type": "boolean", "description": "Sets if key is enabled or disabled", "default": true }, "rateLimitEnabled": { "type": "boolean", "description": "Whether the key has rate limiting enabled" }, "rateLimitTimeWindow": { "type": "number", "nullable": true, "description": "The duration in milliseconds" }, "rateLimitMax": { "type": "number", "nullable": true, "description": "Maximum amount of requests allowed within a window" }, "requestCount": { "type": "number", "description": "The number of requests made within the rate limit time window" }, "remaining": { "type": "number", "nullable": true, "description": "Remaining requests (every time api key is used this should updated and should be updated on refill as well)" }, "lastRequest": { "type": "string", "format": "date-time", "nullable": true, "description": "When last request occurred" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiry date of a key" }, "createdAt": { "type": "string", "format": "date-time", "description": "created at" }, "updatedAt": { "type": "string", "format": "date-time", "description": "updated at" }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Extra metadata about the apiKey" }, "permissions": { "type": "string", "nullable": true, "description": "Permissions for the api key (stored as JSON string)" } }, "required": [ "id", "userId", "enabled", "rateLimitEnabled", "requestCount", "createdAt", "updatedAt" ] } }, "total": { "type": "number", "description": "Total number of API keys" }, "limit": { "type": "number", "nullable": true, "description": "The limit used for pagination" }, "offset": { "type": "number", "nullable": true, "description": "The offset used for pagination" } }, "required": [ "apiKeys", "total" ] } } } }, "get_api_key_list_400_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Bad Request. Usually due to missing parameters, or invalid parameters." }, "get_api_key_list_401_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "description": "Unauthorized. Due to missing or invalid authentication." }, "get_api_key_list_403_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Forbidden. You do not have permission to access this resource or to perform this action." }, "get_api_key_list_404_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Not Found. The requested resource was not found." }, "get_api_key_list_429_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Too Many Requests. You have exceeded the rate limit. Try again later." }, "get_api_key_list_500_response": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "description": "Internal Server Error. This is a problem with the server that you cannot fix." } }, "requestBodies": { "createProject_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "workspaceId": { "type": "string" }, "icon": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "workspaceId", "icon", "slug" ] } } } }, "updateProject_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "isPublic": { "type": "boolean" } }, "required": [ "name", "icon", "slug", "description", "isPublic" ] } } } }, "createTask_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string" }, "priority": { "type": "string" }, "status": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "title", "description", "priority", "status" ] } } } }, "updateTask_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string" }, "priority": { "type": "string" }, "status": { "type": "string" }, "projectId": { "type": "string" }, "position": { "type": "number" }, "userId": { "type": "string" } }, "required": [ "title", "description", "priority", "status", "projectId", "position" ] } } } }, "importTasks_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "priority": { "type": "string" }, "dueDate": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "status" ] } } }, "required": [ "tasks" ] } } } }, "updateTaskStatus_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] } } } }, "updateTaskPriority_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "priority": { "type": "string" } }, "required": [ "priority" ] } } } }, "updateTaskAssignee_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "updateTaskDueDate_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dueDate": { "type": "string" } }, "required": [] } } } }, "updateTaskTitle_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } } } }, "updateTaskDescription_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" } }, "required": [ "description" ] } } } }, "createColumn_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isFinal": { "type": "boolean" } }, "required": [ "name" ] } } } }, "reorderColumns_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" } }, "required": [ "id", "position" ] } } }, "required": [ "columns" ] } } } }, "updateColumn_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isFinal": { "type": "boolean" } }, "required": [] } } } }, "createActivity_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "string" }, "userId": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" } }, "required": [ "taskId", "userId", "message", "type" ] } } } }, "updateComment_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "activityId", "comment" ] } } } }, "createComment_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "taskId", "comment" ] } } } }, "deleteComment_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "string" } }, "required": [ "activityId" ] } } } }, "updateTimeEntry_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "description": { "type": "string" } }, "required": [ "startTime" ] } } } }, "createTimeEntry_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "description": { "type": "string" } }, "required": [ "taskId", "startTime" ] } } } }, "createLabel_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "workspaceId": { "type": "string" }, "taskId": { "type": "string" } }, "required": [ "name", "color", "workspaceId" ] } } } }, "updateLabel_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } } } }, "createNotification_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "relatedEntityId": { "type": "string" }, "relatedEntityType": { "type": "string" } }, "required": [ "userId", "title", "message", "type" ] } } } }, "verifyGitHubInstallation_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repositoryOwner": { "type": "string", "minLength": 1 }, "repositoryName": { "type": "string", "minLength": 1 } }, "required": [ "repositoryOwner", "repositoryName" ] } } } }, "createGitHubIntegration_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repositoryOwner": { "type": "string", "minLength": 1 }, "repositoryName": { "type": "string", "minLength": 1 } }, "required": [ "repositoryOwner", "repositoryName" ] } } } }, "updateGitHubIntegration_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "required": [] } } } }, "importGitHubIssues_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string" } }, "required": [ "projectId" ] } } } }, "upsertWorkflowRule_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationType": { "type": "string" }, "eventType": { "type": "string" }, "columnId": { "type": "string" } }, "required": [ "integrationType", "eventType", "columnId" ] } } } }, "socialSignIn_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "callbackURL": { "type": [ "string", "null" ], "description": "Callback URL to redirect to after the user has signed in" }, "newUserCallbackURL": { "type": [ "string", "null" ] }, "errorCallbackURL": { "type": [ "string", "null" ], "description": "Callback URL to redirect to if an error happens" }, "provider": { "type": "string" }, "disableRedirect": { "type": [ "boolean", "null" ], "description": "Disable automatic redirection to the provider. Useful for handling the redirection yourself" }, "idToken": { "type": [ "object", "null" ], "properties": { "token": { "type": "string", "description": "ID token from the provider" }, "nonce": { "type": [ "string", "null" ], "description": "Nonce used to generate the token" }, "accessToken": { "type": [ "string", "null" ], "description": "Access token from the provider" }, "refreshToken": { "type": [ "string", "null" ], "description": "Refresh token from the provider" }, "expiresAt": { "type": [ "number", "null" ], "description": "Expiry date of the token" } }, "required": [ "token" ] }, "scopes": { "type": [ "array", "null" ], "description": "Array of scopes to request from the provider. This will override the default scopes passed." }, "requestSignUp": { "type": [ "boolean", "null" ], "description": "Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider" }, "loginHint": { "type": [ "string", "null" ], "description": "The login hint to use for the authorization code request" }, "additionalData": { "type": [ "string", "null" ] } }, "required": [ "provider" ] } } } }, "post_callback_id_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "getSession_post_get_session_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "signOut_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "signUpWithEmailAndPassword_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the user" }, "email": { "type": "string", "description": "The email of the user" }, "password": { "type": "string", "description": "The password of the user" }, "image": { "type": "string", "description": "The profile image URL of the user" }, "callbackURL": { "type": "string", "description": "The URL to use for email verification callback" }, "rememberMe": { "type": "boolean", "description": "If this is false, the session will not be remembered. Default is `true`." } }, "required": [ "name", "email", "password" ] } } } }, "signInEmail_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email of the user" }, "password": { "type": "string", "description": "Password of the user" }, "callbackURL": { "type": [ "string", "null" ], "description": "Callback URL to use as a redirect for email verification" }, "rememberMe": { "type": [ "boolean", "null" ], "description": "If this is false, the session will not be remembered. Default is `true`.", "default": true } }, "required": [ "email", "password" ] } } } }, "resetPassword_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newPassword": { "type": "string", "description": "The new password to set" }, "token": { "type": [ "string", "null" ], "description": "The token to reset the password" } }, "required": [ "newPassword" ] } } } }, "verifyPassword_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "description": "The password to verify" } }, "required": [ "password" ] } } } }, "sendVerificationEmail_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "The email to send the verification email to", "example": "user@example.com" }, "callbackURL": { "type": "string", "description": "The URL to use for email verification callback", "example": "https://example.com/callback", "nullable": true } }, "required": [ "email" ] } } } }, "changeEmail_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newEmail": { "type": "string", "description": "The new email address to set must be a valid email address" }, "callbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to after email verification" } }, "required": [ "newEmail" ] } } } }, "changePassword_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newPassword": { "type": "string", "description": "The new password to set" }, "currentPassword": { "type": "string", "description": "The current password is required" }, "revokeOtherSessions": { "type": [ "boolean", "null" ], "description": "Must be a boolean value" } }, "required": [ "newPassword", "currentPassword" ] } } } }, "updateSession_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "updateUser_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the user" }, "image": { "type": "string", "description": "The image of the user", "nullable": true } } } } } }, "deleteUser_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callbackURL": { "type": "string", "description": "The callback URL to redirect to after the user is deleted" }, "password": { "type": "string", "description": "The user's password. Required if session is not fresh" }, "token": { "type": "string", "description": "The deletion verification token" } } } } } }, "requestPasswordReset_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the user to send a password reset email to" }, "redirectTo": { "type": [ "string", "null" ], "description": "The URL to redirect the user to reset their password. If the token isn't valid or expired, it'll be redirected with a query parameter `?error=INVALID_TOKEN`. If the token is valid, it'll be redirected with a query parameter `?token=VALID_TOKEN" } }, "required": [ "email" ] } } } }, "post_revoke_session_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "The token to revoke" } }, "required": [ "token" ] } } } }, "post_revoke_sessions_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "post_revoke_other_sessions_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "linkSocialAccount_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "callbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to after the user has signed in" }, "provider": { "type": "string" }, "idToken": { "type": [ "object", "null" ], "properties": { "token": { "type": "string" }, "nonce": { "type": [ "string", "null" ] }, "accessToken": { "type": [ "string", "null" ] }, "refreshToken": { "type": [ "string", "null" ] }, "scopes": { "type": [ "array", "null" ] } }, "required": [ "token" ] }, "requestSignUp": { "type": [ "boolean", "null" ] }, "scopes": { "type": [ "array", "null" ], "description": "Additional scopes to request from the provider" }, "errorCallbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to if there is an error during the link process" }, "disableRedirect": { "type": [ "boolean", "null" ], "description": "Disable automatic redirection to the provider. Useful for handling the redirection yourself" }, "additionalData": { "type": [ "string", "null" ] } }, "required": [ "provider" ] } } } }, "post_unlink_account_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providerId": { "type": "string" }, "accountId": { "type": [ "string", "null" ] } }, "required": [ "providerId" ] } } } }, "post_refresh_token_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providerId": { "type": "string", "description": "The provider ID for the OAuth provider" }, "accountId": { "type": [ "string", "null" ], "description": "The account ID associated with the refresh token" }, "userId": { "type": [ "string", "null" ], "description": "The user ID associated with the account" } }, "required": [ "providerId" ] } } } }, "post_get_access_token_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providerId": { "type": "string", "description": "The provider ID for the OAuth provider" }, "accountId": { "type": [ "string", "null" ], "description": "The account ID associated with the refresh token" }, "userId": { "type": [ "string", "null" ], "description": "The user ID associated with the account" } }, "required": [ "providerId" ] } } } }, "signInWithMagicLink_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to send the magic link" }, "name": { "type": [ "string", "null" ], "description": "User display name. Only used if the user is registering for the first time. Eg: \"my-name\"" }, "callbackURL": { "type": [ "string", "null" ], "description": "URL to redirect after magic link verification" }, "newUserCallbackURL": { "type": [ "string", "null" ], "description": "URL to redirect after new user signup. Only used if the user is registering for the first time." }, "errorCallbackURL": { "type": [ "string", "null" ], "description": "URL to redirect after error." } }, "required": [ "email" ] } } } }, "sendEmailVerificationOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to send the OTP" }, "type": { "type": "string", "description": "Type of the OTP" } }, "required": [ "email", "type" ] } } } }, "verifyEmailWithOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address the OTP was sent to" }, "type": { "type": "string", "description": "Type of the OTP" }, "otp": { "type": "string", "description": "OTP to verify" } }, "required": [ "email", "type", "otp" ] } } } }, "post_email_otp_verify_email_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to verify" }, "otp": { "type": "string", "description": "OTP to verify" } }, "required": [ "email", "otp" ] } } } }, "requestPasswordResetWithEmailOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to send the OTP" } }, "required": [ "email" ] } } } }, "forgetPasswordWithEmailOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to send the OTP" } }, "required": [ "email" ] } } } }, "resetPasswordWithEmailOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to reset the password" }, "otp": { "type": "string", "description": "OTP sent to the email" }, "password": { "type": "string", "description": "New password" } }, "required": [ "email", "otp", "password" ] } } } }, "requestEmailChangeWithEmailOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newEmail": { "type": "string", "description": "New email address to send the OTP" }, "otp": { "type": [ "string", "null" ] } }, "required": [ "newEmail" ] } } } }, "changeEmailWithEmailOTP_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newEmail": { "type": "string", "description": "New email address to verify and change to" }, "otp": { "type": "string", "description": "OTP sent to the new email" } }, "required": [ "newEmail", "otp" ] } } } }, "post_organization_create_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the organization" }, "slug": { "type": "string", "description": "The slug of the organization" }, "userId": { "type": [ "string", "null" ], "description": "The user id of the organization creator. If not provided, the current user will be used. Should only be used by admins or when called by the server. server-only. Eg: \"user-id\"" }, "logo": { "type": [ "string", "null" ], "description": "The logo of the organization" }, "metadata": { "type": [ "string", "null" ], "description": "The metadata of the organization" }, "keepCurrentActiveOrganization": { "type": [ "boolean", "null" ], "description": "Whether to keep the current active organization active after creating a new one. Eg: true" }, "description": { "type": [ "string", "null" ] } }, "required": [ "name", "slug" ] } } } }, "post_organization_update_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "description": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ], "description": "The name of the organization" }, "slug": { "type": [ "string", "null" ], "description": "The slug of the organization" }, "logo": { "type": [ "string", "null" ], "description": "The logo of the organization" }, "metadata": { "type": [ "string", "null" ], "description": "The metadata of the organization" } } }, "organizationId": { "type": [ "string", "null" ], "description": "The organization ID. Eg: \"org-id\"" } }, "required": [ "data" ] } } } }, "post_organization_delete_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The organization id to delete" } }, "required": [ "organizationId" ] } } } }, "setActiveOrganization_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": [ "string", "null" ] }, "organizationSlug": { "type": [ "string", "null" ], "description": "The organization slug to set as active. It can be null to unset the active organization if organizationId is not provided. Eg: \"org-slug\"" } }, "required": [] } } } }, "createOrganizationInvitation_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the user to invite" }, "role": { "type": "string", "description": "The role(s) to assign to the user. It can be `admin`, `member`, owner. Eg: \"member\"" }, "organizationId": { "type": [ "string", "null" ], "description": "The organization ID to invite the user to" }, "resend": { "type": [ "boolean", "null" ], "description": "Resend the invitation email, if the user is already invited. Eg: true" }, "teamId": { "type": "string" } }, "required": [ "email", "role", "teamId" ] } } } }, "post_organization_cancel_invitation_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationId": { "type": "string", "description": "The ID of the invitation to cancel" } }, "required": [ "invitationId" ] } } } }, "post_organization_accept_invitation_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationId": { "type": "string", "description": "The ID of the invitation to accept" } }, "required": [ "invitationId" ] } } } }, "post_organization_reject_invitation_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationId": { "type": "string", "description": "The ID of the invitation to reject" } }, "required": [ "invitationId" ] } } } }, "post_organization_check_slug_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "The organization slug to check. Eg: \"my-org\"" } }, "required": [ "slug" ] } } } }, "post_organization_remove_member_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "memberIdOrEmail": { "type": "string", "description": "The ID or email of the member to remove" }, "organizationId": { "type": [ "string", "null" ], "description": "The ID of the organization to remove the member from. If not provided, the active organization will be used. Eg: \"org-id\"" } }, "required": [ "memberIdOrEmail" ] } } } }, "updateOrganizationMemberRole_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "description": "The new role to be applied. This can be a string or array of strings representing the roles. Eg: [\"admin\", \"sale\"]" }, "memberId": { "type": "string", "description": "The member id to apply the role update to. Eg: \"member-id\"" }, "organizationId": { "type": [ "string", "null" ], "description": "An optional organization ID which the member is a part of to apply the role update. If not provided, you must provide session headers to get the active organization. Eg: \"organization-id\"" } }, "required": [ "role", "memberId" ] } } } }, "post_organization_leave_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The organization Id for the member to leave. Eg: \"organization-id\"" } }, "required": [ "organizationId" ] } } } }, "post_organization_create_team_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team. Eg: \"my-team\"" }, "organizationId": { "type": [ "string", "null" ], "description": "The organization ID which the team will be created in. Defaults to the active organization. Eg: \"organization-id\"" } }, "required": [ "name" ] } } } }, "post_organization_remove_team_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "string", "description": "The team ID of the team to remove. Eg: \"team-id\"" }, "organizationId": { "type": [ "string", "null" ], "description": "The organization ID which the team falls under. If not provided, it will default to the user's active organization. Eg: \"organization-id\"" } }, "required": [ "teamId" ] } } } }, "post_organization_update_team_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "string", "description": "The ID of the team to be updated. Eg: \"team-id\"" }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "default": "icQPfLVaGoklNpvoH3pn9AZiFFsoFAqD" }, "name": { "type": [ "string", "null" ] }, "organizationId": { "type": [ "string", "null" ] }, "createdAt": { "type": [ "string", "null" ] }, "updatedAt": { "type": [ "string", "null" ] } } } }, "required": [ "teamId", "data" ] } } } }, "post_organization_set_active_team_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": [ "string", "null" ] } }, "required": [] } } } }, "post_organization_add_team_member_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "string", "description": "The team the user should be a member of." }, "userId": { "type": "string", "description": "The user Id which represents the user to be added as a member." } }, "required": [ "teamId", "userId" ] } } } }, "post_organization_remove_team_member_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "teamId": { "type": "string", "description": "The team the user should be removed from." }, "userId": { "type": "string", "description": "The user which should be removed from the team." } }, "required": [ "teamId", "userId" ] } } } }, "post_organization_has_permission_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "type": "object", "description": "The permission to check", "deprecated": true }, "permissions": { "type": "object", "description": "The permission to check" } }, "required": [ "permissions" ] } } } }, "post_sign_in_oauth2_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providerId": { "type": "string", "description": "The provider ID for the OAuth provider" }, "callbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to after sign in" }, "errorCallbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to if an error occurs" }, "newUserCallbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to after login if the user is new. Eg: \"/welcome\"" }, "disableRedirect": { "type": [ "boolean", "null" ], "description": "Disable redirect" }, "scopes": { "type": [ "array", "null" ], "description": "Scopes to be passed to the provider authorization request." }, "requestSignUp": { "type": [ "boolean", "null" ], "description": "Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider. Eg: false" }, "additionalData": { "type": [ "string", "null" ] } }, "required": [ "providerId" ] } } } }, "post_oauth2_link_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providerId": { "type": "string" }, "callbackURL": { "type": "string" }, "scopes": { "type": [ "array", "null" ], "description": "Additional scopes to request when linking the account" }, "errorCallbackURL": { "type": [ "string", "null" ], "description": "The URL to redirect to if there is an error during the link process" } }, "required": [ "providerId", "callbackURL" ] } } } }, "post_api_key_create_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "configId": { "type": [ "string", "null" ], "description": "The configuration ID to use for the API key. If not provided, the default configuration will be used." }, "name": { "type": [ "string", "null" ], "description": "Name of the Api Key" }, "expiresIn": { "type": "string", "default": null }, "prefix": { "type": [ "string", "null" ], "description": "Prefix of the Api Key" }, "remaining": { "type": "string", "default": null }, "metadata": { "type": [ "string", "null" ] }, "refillAmount": { "type": [ "number", "null" ], "description": "Amount to refill the remaining count of the Api Key. server-only. Eg: 100" }, "refillInterval": { "type": [ "number", "null" ], "description": "Interval to refill the Api Key in milliseconds. server-only. Eg: 1000" }, "rateLimitTimeWindow": { "type": [ "number", "null" ], "description": "The duration in milliseconds where each request is counted. Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset. server-only. Eg: 1000" }, "rateLimitMax": { "type": [ "number", "null" ], "description": "Maximum amount of requests allowed within a window. Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset. server-only. Eg: 100" }, "rateLimitEnabled": { "type": [ "boolean", "null" ], "description": "Whether the key has rate limiting enabled. server-only. Eg: true" }, "permissions": { "type": [ "string", "null" ], "description": "Permissions of the Api Key." }, "userId": { "type": [ "string", "null" ], "description": "User Id of the user that the Api Key belongs to. server-only. Eg: \"user-id\"" }, "organizationId": { "type": [ "string", "null" ], "description": "Organization Id of the organization that the Api Key belongs to. Eg: 'org-id'" } }, "required": [ "expiresIn", "remaining" ] } } } }, "post_api_key_update_request_body": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "configId": { "type": [ "string", "null" ], "description": "The configuration ID to use for the API key lookup. If not provided, the default configuration will be used." }, "keyId": { "type": "string", "description": "The id of the Api Key" }, "userId": { "type": [ "string", "null" ], "description": "The id of the user which the api key belongs to. server-only. Eg: \"some-user-id\"" }, "name": { "type": [ "string", "null" ], "description": "The name of the key" }, "enabled": { "type": [ "boolean", "null" ], "description": "Whether the Api Key is enabled or not" }, "remaining": { "type": [ "number", "null" ], "description": "The number of remaining requests" }, "refillAmount": { "type": [ "number", "null" ], "description": "The refill amount" }, "refillInterval": { "type": [ "number", "null" ], "description": "The refill interval" }, "metadata": { "type": [ "string", "null" ] }, "expiresIn": { "type": "string" }, "rateLimitEnabled": { "type": [ "boolean", "null" ], "description": "Whether the key has rate limiting enabled." }, "rateLimitTimeWindow": { "type": [ "number", "null" ], "description": "The duration in milliseconds where each request is counted. server-only. Eg: 1000" }, "rateLimitMax": { "type": [ "number", "null" ], "description": "Maximum amount of requests allowed within a window. Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset. server-only. Eg: 100" }, "permissions": { "type": "string" } }, "required": [ "keyId", "expiresIn", "permissions" ] } } } }, "post_api_key_delete_request_body": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keyId": { "type": "string", "description": "The id of the API key to delete" } }, "required": [ "keyId" ] } } } } }, "parameters": { "workspaceId_query_spec_paths_project_get_parameters_0": { "in": "query", "name": "workspaceId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_project_id_get_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "workspaceId_query_spec_paths_project_id_get_parameters_1": { "in": "query", "name": "workspaceId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_project_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_project_id_delete_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_task_tasks_projectId_get_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_task_projectId_post_parameters_0": { "schema": { "type": "string" }, "in": "path", "name": "projectId", "required": true }, "id_path_spec_paths_task_id_get_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_id_delete_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_task_export_projectId_get_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_task_import_projectId_post_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_status_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_priority_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_assignee_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_due_date_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_title_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_task_description_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_column_projectId_get_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_column_projectId_post_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_column_reorder_projectId_put_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_column_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_column_id_delete_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "taskId_path_spec_paths_activity_taskId_get_parameters_0": { "in": "path", "name": "taskId", "schema": { "type": "string" }, "required": true }, "taskId_path_spec_paths_time_entry_task_taskId_get_parameters_0": { "in": "path", "name": "taskId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_time_entry_id_get_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_time_entry_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "taskId_path_spec_paths_label_task_taskId_get_parameters_0": { "in": "path", "name": "taskId", "schema": { "type": "string" }, "required": true }, "workspaceId_path_spec_paths_label_workspace_workspaceId_get_parameters_0": { "in": "path", "name": "workspaceId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_label_id_get_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_label_id_put_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_label_id_delete_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_notification_id_read_patch_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "q_query_spec_paths_search_get_parameters_0": { "in": "query", "name": "q", "schema": { "type": "string", "minLength": 1 }, "required": true }, "type_query_spec_paths_search_get_parameters_1": { "in": "query", "name": "type", "schema": { "enum": [ "all", "tasks", "projects", "workspaces", "comments", "activities" ], "default": "all" } }, "workspaceId_query_spec_paths_search_get_parameters_2": { "in": "query", "name": "workspaceId", "schema": { "type": "string" } }, "projectId_query_spec_paths_search_get_parameters_3": { "in": "query", "name": "projectId", "schema": { "type": "string" } }, "limit_query_spec_paths_search_get_parameters_4": { "in": "query", "name": "limit", "schema": { "type": "string", "minimum": 1, "maximum": 50, "default": "20" } }, "userEmail_query_spec_paths_search_get_parameters_5": { "in": "query", "name": "userEmail", "schema": { "type": "string", "format": "email" } }, "projectId_path_spec_paths_github_integration_project_projectId_get_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_github_integration_project_projectId_post_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_github_integration_project_projectId_patch_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_github_integration_project_projectId_delete_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "taskId_path_spec_paths_external_link_task_taskId_get_parameters_0": { "in": "path", "name": "taskId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_workflow_rule_projectId_get_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "projectId_path_spec_paths_workflow_rule_projectId_put_parameters_0": { "in": "path", "name": "projectId", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_workflow_rule_id_delete_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "id_path_spec_paths_invitation_id_get_parameters_0": { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, "token_query_spec_paths_verify_email_get_parameters_0": { "name": "token", "in": "query", "description": "The token to verify the email", "required": true, "schema": { "type": "string" } }, "callbackURL_query_spec_paths_verify_email_get_parameters_1": { "name": "callbackURL", "in": "query", "description": "The URL to redirect to after email verification", "required": false, "schema": { "type": "string" } }, "token_path_spec_paths_reset_password_token_get_parameters_0": { "name": "token", "in": "path", "required": true, "description": "The token to reset the password", "schema": { "type": "string" } }, "callbackURL_query_spec_paths_reset_password_token_get_parameters_1": { "name": "callbackURL", "in": "query", "required": true, "description": "The URL to redirect the user to reset their password", "schema": { "type": "string" } }, "token_query_spec_paths_delete_user_callback_get_parameters_0": { "name": "token", "in": "query", "schema": { "type": "string", "description": "The token to verify the deletion request" } }, "callbackURL_query_spec_paths_delete_user_callback_get_parameters_1": { "name": "callbackURL", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The URL to redirect to after deletion" } }, "token_query_spec_paths_magic_link_verify_get_parameters_0": { "name": "token", "in": "query", "schema": { "type": "string", "description": "Verification token" } }, "callbackURL_query_spec_paths_magic_link_verify_get_parameters_1": { "name": "callbackURL", "in": "query", "schema": { "type": [ "string", "null" ], "description": "URL to redirect after magic link verification, if not provided the user will be redirected to the root URL. Eg: \"/dashboard\"" } }, "errorCallbackURL_query_spec_paths_magic_link_verify_get_parameters_2": { "name": "errorCallbackURL", "in": "query", "schema": { "type": [ "string", "null" ], "description": "URL to redirect after error." } }, "newUserCallbackURL_query_spec_paths_magic_link_verify_get_parameters_3": { "name": "newUserCallbackURL", "in": "query", "schema": { "type": [ "string", "null" ], "description": "URL to redirect after new user signup. Only used if the user is registering for the first time." } }, "id_query_spec_paths_organization_get_invitation_get_parameters_0": { "name": "id", "in": "query", "schema": { "type": "string", "description": "The ID of the invitation to get" } }, "code_query_spec_paths_oauth2_callback_providerId_get_parameters_0": { "name": "code", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The OAuth2 code" } }, "error_query_spec_paths_oauth2_callback_providerId_get_parameters_1": { "name": "error", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The error message, if any" } }, "error_description_query_spec_paths_oauth2_callback_providerId_get_parameters_2": { "name": "error_description", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The error description, if any" } }, "state_query_spec_paths_oauth2_callback_providerId_get_parameters_3": { "name": "state", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The state parameter from the OAuth2 request" } }, "iss_query_spec_paths_oauth2_callback_providerId_get_parameters_4": { "name": "iss", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The issuer identifier" } }, "configId_query_spec_paths_api_key_get_get_parameters_0": { "name": "configId", "in": "query", "schema": { "type": [ "string", "null" ], "description": "The configuration ID to use for the API key lookup. If not provided, the default configuration will be used." } }, "id_query_spec_paths_api_key_get_get_parameters_1": { "name": "id", "in": "query", "schema": { "type": "string", "description": "The id of the Api Key" } } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/config": { "get": { "operationId": "getConfig", "tags": [ "Config" ], "description": "Get application settings and configuration", "responses": { "200": { "$ref": "#/components/responses/getConfig_200_response" } } } }, "/project": { "get": { "operationId": "listProjects", "tags": [ "Projects" ], "description": "Get all projects in a workspace", "responses": { "200": { "$ref": "#/components/responses/listProjects_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/workspaceId_query_spec_paths_project_get_parameters_0" } ] }, "post": { "operationId": "createProject", "tags": [ "Projects" ], "description": "Create a new project in a workspace", "responses": { "200": { "$ref": "#/components/responses/createProject_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createProject_request_body" } } }, "/project/{id}": { "get": { "operationId": "getProject", "tags": [ "Projects" ], "description": "Get a specific project by ID", "responses": { "200": { "$ref": "#/components/responses/getProject_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_project_id_get_parameters_0" }, { "$ref": "#/components/parameters/workspaceId_query_spec_paths_project_id_get_parameters_1" } ] }, "put": { "operationId": "updateProject", "tags": [ "Projects" ], "description": "Update an existing project", "responses": { "200": { "$ref": "#/components/responses/updateProject_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_project_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateProject_request_body" } }, "delete": { "operationId": "deleteProject", "tags": [ "Projects" ], "description": "Delete a project by ID", "responses": { "200": { "$ref": "#/components/responses/deleteProject_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_project_id_delete_parameters_0" } ] } }, "/task/tasks/{projectId}": { "get": { "operationId": "listTasks", "tags": [ "Tasks" ], "description": "Get all tasks for a specific project", "responses": { "200": { "$ref": "#/components/responses/listTasks_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_task_tasks_projectId_get_parameters_0" } ] } }, "/task/{projectId}": { "post": { "operationId": "createTask", "tags": [ "Tasks" ], "description": "Create a new task in a project", "responses": { "200": { "$ref": "#/components/responses/createTask_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createTask_request_body" }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_task_projectId_post_parameters_0" } ] } }, "/task/{id}": { "get": { "operationId": "getTask", "tags": [ "Tasks" ], "description": "Get a specific task by ID", "responses": { "200": { "$ref": "#/components/responses/getTask_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_id_get_parameters_0" } ] }, "put": { "operationId": "updateTask", "tags": [ "Tasks" ], "description": "Update all fields of a task", "responses": { "200": { "$ref": "#/components/responses/updateTask_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTask_request_body" } }, "delete": { "operationId": "deleteTask", "tags": [ "Tasks" ], "description": "Delete a task by ID", "responses": { "200": { "$ref": "#/components/responses/deleteTask_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_id_delete_parameters_0" } ] } }, "/task/export/{projectId}": { "get": { "operationId": "exportTasks", "tags": [ "Tasks" ], "description": "Export all tasks from a project", "responses": { "200": { "$ref": "#/components/responses/exportTasks_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_task_export_projectId_get_parameters_0" } ] } }, "/task/import/{projectId}": { "post": { "operationId": "importTasks", "tags": [ "Tasks" ], "description": "Import multiple tasks into a project", "responses": { "200": { "$ref": "#/components/responses/importTasks_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_task_import_projectId_post_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/importTasks_request_body" } } }, "/task/status/{id}": { "put": { "operationId": "updateTaskStatus", "tags": [ "Tasks" ], "description": "Update only the status of a task", "responses": { "200": { "$ref": "#/components/responses/updateTaskStatus_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_status_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskStatus_request_body" } } }, "/task/priority/{id}": { "put": { "operationId": "updateTaskPriority", "tags": [ "Tasks" ], "description": "Update only the priority of a task", "responses": { "200": { "$ref": "#/components/responses/updateTaskPriority_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_priority_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskPriority_request_body" } } }, "/task/assignee/{id}": { "put": { "operationId": "updateTaskAssignee", "tags": [ "Tasks" ], "description": "Assign or unassign a task to a user", "responses": { "200": { "$ref": "#/components/responses/updateTaskAssignee_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_assignee_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskAssignee_request_body" } } }, "/task/due-date/{id}": { "put": { "operationId": "updateTaskDueDate", "tags": [ "Tasks" ], "description": "Update only the due date of a task", "responses": { "200": { "$ref": "#/components/responses/updateTaskDueDate_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_due_date_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskDueDate_request_body" } } }, "/task/title/{id}": { "put": { "operationId": "updateTaskTitle", "tags": [ "Tasks" ], "description": "Update only the title of a task", "responses": { "200": { "$ref": "#/components/responses/updateTaskTitle_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_title_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskTitle_request_body" } } }, "/task/description/{id}": { "put": { "operationId": "updateTaskDescription", "tags": [ "Tasks" ], "description": "Update only the description of a task", "responses": { "200": { "$ref": "#/components/responses/updateTaskDescription_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_task_description_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTaskDescription_request_body" } } }, "/column/{projectId}": { "get": { "operationId": "getColumns", "tags": [ "Columns" ], "description": "Get all columns for a project", "responses": { "200": { "$ref": "#/components/responses/getColumns_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_column_projectId_get_parameters_0" } ] }, "post": { "operationId": "createColumn", "tags": [ "Columns" ], "description": "Create a new column in a project", "responses": { "200": { "$ref": "#/components/responses/createColumn_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_column_projectId_post_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/createColumn_request_body" } } }, "/column/reorder/{projectId}": { "put": { "operationId": "reorderColumns", "tags": [ "Columns" ], "description": "Reorder columns in a project", "responses": { "200": { "$ref": "#/components/responses/reorderColumns_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_column_reorder_projectId_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/reorderColumns_request_body" } } }, "/column/{id}": { "put": { "operationId": "updateColumn", "tags": [ "Columns" ], "description": "Update a column", "responses": { "200": { "$ref": "#/components/responses/updateColumn_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_column_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateColumn_request_body" } }, "delete": { "operationId": "deleteColumn", "tags": [ "Columns" ], "description": "Delete a column", "responses": { "200": { "$ref": "#/components/responses/deleteColumn_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_column_id_delete_parameters_0" } ] } }, "/activity/{taskId}": { "get": { "operationId": "getActivities", "tags": [ "Activity" ], "description": "Get all activities for a specific task", "responses": { "200": { "$ref": "#/components/responses/getActivities_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/taskId_path_spec_paths_activity_taskId_get_parameters_0" } ] } }, "/activity/create": { "post": { "operationId": "createActivity", "tags": [ "Activity" ], "description": "Create a new activity (system-generated event)", "responses": { "200": { "$ref": "#/components/responses/createActivity_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createActivity_request_body" } } }, "/activity/comment": { "post": { "operationId": "createComment", "tags": [ "Activity" ], "description": "Create a new comment on a task", "responses": { "200": { "$ref": "#/components/responses/createComment_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createComment_request_body" } }, "put": { "operationId": "updateComment", "tags": [ "Activity" ], "description": "Update an existing comment", "responses": { "200": { "$ref": "#/components/responses/updateComment_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/updateComment_request_body" } }, "delete": { "operationId": "deleteComment", "tags": [ "Activity" ], "description": "Delete a comment", "responses": { "200": { "$ref": "#/components/responses/deleteComment_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/deleteComment_request_body" } } }, "/time-entry/task/{taskId}": { "get": { "operationId": "getTaskTimeEntries", "tags": [ "Time Entries" ], "description": "Get all time entries for a specific task", "responses": { "200": { "$ref": "#/components/responses/getTaskTimeEntries_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/taskId_path_spec_paths_time_entry_task_taskId_get_parameters_0" } ] } }, "/time-entry/{id}": { "get": { "operationId": "getTimeEntry", "tags": [ "Time Entries" ], "description": "Get a specific time entry by ID", "responses": { "200": { "$ref": "#/components/responses/getTimeEntry_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_time_entry_id_get_parameters_0" } ] }, "put": { "operationId": "updateTimeEntry", "tags": [ "Time Entries" ], "description": "Update an existing time entry", "responses": { "200": { "$ref": "#/components/responses/updateTimeEntry_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_time_entry_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateTimeEntry_request_body" } } }, "/time-entry": { "post": { "operationId": "createTimeEntry", "tags": [ "Time Entries" ], "description": "Create a new time entry for a task", "responses": { "200": { "$ref": "#/components/responses/createTimeEntry_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createTimeEntry_request_body" } } }, "/label/task/{taskId}": { "get": { "operationId": "getTaskLabels", "tags": [ "Labels" ], "description": "Get all labels assigned to a specific task", "responses": { "200": { "$ref": "#/components/responses/getTaskLabels_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/taskId_path_spec_paths_label_task_taskId_get_parameters_0" } ] } }, "/label/workspace/{workspaceId}": { "get": { "operationId": "getWorkspaceLabels", "tags": [ "Labels" ], "description": "Get all labels for a specific workspace", "responses": { "200": { "$ref": "#/components/responses/getWorkspaceLabels_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/workspaceId_path_spec_paths_label_workspace_workspaceId_get_parameters_0" } ] } }, "/label": { "post": { "operationId": "createLabel", "tags": [ "Labels" ], "description": "Create a new label in a workspace", "responses": { "200": { "$ref": "#/components/responses/createLabel_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createLabel_request_body" } } }, "/label/{id}": { "get": { "operationId": "getLabel", "tags": [ "Labels" ], "description": "Get a specific label by ID", "responses": { "200": { "$ref": "#/components/responses/getLabel_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_label_id_get_parameters_0" } ] }, "put": { "operationId": "updateLabel", "tags": [ "Labels" ], "description": "Update an existing label", "responses": { "200": { "$ref": "#/components/responses/updateLabel_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_label_id_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateLabel_request_body" } }, "delete": { "operationId": "deleteLabel", "tags": [ "Labels" ], "description": "Delete a label by ID", "responses": { "200": { "$ref": "#/components/responses/deleteLabel_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_label_id_delete_parameters_0" } ] } }, "/notification": { "get": { "operationId": "listNotifications", "tags": [ "Notifications" ], "description": "Get all notifications for the current user", "responses": { "200": { "$ref": "#/components/responses/listNotifications_200_response" } } }, "post": { "operationId": "createNotification", "tags": [ "Notifications" ], "description": "Create a new notification for a user", "responses": { "200": { "$ref": "#/components/responses/createNotification_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/createNotification_request_body" } } }, "/notification/{id}/read": { "patch": { "operationId": "markNotificationAsRead", "tags": [ "Notifications" ], "description": "Mark a specific notification as read", "responses": { "200": { "$ref": "#/components/responses/markNotificationAsRead_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_notification_id_read_patch_parameters_0" } ] } }, "/notification/read-all": { "patch": { "operationId": "markAllNotificationsAsRead", "tags": [ "Notifications" ], "description": "Mark all notifications as read for the current user", "responses": { "200": { "$ref": "#/components/responses/markAllNotificationsAsRead_200_response" } } } }, "/notification/clear-all": { "delete": { "operationId": "clearAllNotifications", "tags": [ "Notifications" ], "description": "Clear all notifications for the current user", "responses": { "200": { "$ref": "#/components/responses/clearAllNotifications_200_response" } } } }, "/search": { "get": { "operationId": "globalSearch", "tags": [ "Search" ], "description": "Search across tasks, projects, workspaces, comments, and activities", "responses": { "200": { "$ref": "#/components/responses/globalSearch_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/q_query_spec_paths_search_get_parameters_0" }, { "$ref": "#/components/parameters/type_query_spec_paths_search_get_parameters_1" }, { "$ref": "#/components/parameters/workspaceId_query_spec_paths_search_get_parameters_2" }, { "$ref": "#/components/parameters/projectId_query_spec_paths_search_get_parameters_3" }, { "$ref": "#/components/parameters/limit_query_spec_paths_search_get_parameters_4" }, { "$ref": "#/components/parameters/userEmail_query_spec_paths_search_get_parameters_5" } ] } }, "/github-integration/app-info": { "get": { "operationId": "getGitHubAppInfo", "tags": [ "GitHub" ], "description": "Get GitHub app configuration information", "responses": { "200": { "$ref": "#/components/responses/getGitHubAppInfo_200_response" } } } }, "/github-integration/repositories": { "get": { "operationId": "listGitHubRepositories", "tags": [ "GitHub" ], "description": "List all accessible GitHub repositories", "responses": { "200": { "$ref": "#/components/responses/listGitHubRepositories_200_response" } } } }, "/github-integration/verify": { "post": { "operationId": "verifyGitHubInstallation", "tags": [ "GitHub" ], "description": "Verify GitHub app installation for a repository", "responses": { "200": { "$ref": "#/components/responses/verifyGitHubInstallation_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/verifyGitHubInstallation_request_body" } } }, "/github-integration/project/{projectId}": { "get": { "operationId": "getGitHubIntegration", "tags": [ "GitHub" ], "description": "Get GitHub integration for a project", "responses": { "200": { "$ref": "#/components/responses/getGitHubIntegration_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_github_integration_project_projectId_get_parameters_0" } ] }, "post": { "operationId": "createGitHubIntegration", "tags": [ "GitHub" ], "description": "Create a new GitHub integration for a project", "responses": { "200": { "$ref": "#/components/responses/createGitHubIntegration_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_github_integration_project_projectId_post_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/createGitHubIntegration_request_body" } }, "patch": { "operationId": "updateGitHubIntegration", "tags": [ "GitHub" ], "description": "Update GitHub integration settings", "responses": { "200": { "$ref": "#/components/responses/updateGitHubIntegration_200_response" }, "404": { "$ref": "#/components/responses/updateGitHubIntegration_404_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_github_integration_project_projectId_patch_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/updateGitHubIntegration_request_body" } }, "delete": { "operationId": "deleteGitHubIntegration", "tags": [ "GitHub" ], "description": "Delete GitHub integration for a project", "responses": { "200": { "$ref": "#/components/responses/deleteGitHubIntegration_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_github_integration_project_projectId_delete_parameters_0" } ] } }, "/github-integration/import-issues": { "post": { "operationId": "importGitHubIssues", "tags": [ "GitHub" ], "description": "Import GitHub issues as tasks", "responses": { "200": { "$ref": "#/components/responses/importGitHubIssues_200_response" } }, "requestBody": { "$ref": "#/components/requestBodies/importGitHubIssues_request_body" } } }, "/external-link/task/{taskId}": { "get": { "operationId": "getExternalLinksByTask", "tags": [ "External Links" ], "description": "Get all external links for a task", "responses": { "200": { "$ref": "#/components/responses/getExternalLinksByTask_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/taskId_path_spec_paths_external_link_task_taskId_get_parameters_0" } ] } }, "/workflow-rule/{projectId}": { "get": { "operationId": "getWorkflowRules", "tags": [ "Workflow Rules" ], "description": "Get all workflow rules for a project", "responses": { "200": { "$ref": "#/components/responses/getWorkflowRules_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_workflow_rule_projectId_get_parameters_0" } ] }, "put": { "operationId": "upsertWorkflowRule", "tags": [ "Workflow Rules" ], "description": "Create or update a workflow rule", "responses": { "200": { "$ref": "#/components/responses/upsertWorkflowRule_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/projectId_path_spec_paths_workflow_rule_projectId_put_parameters_0" } ], "requestBody": { "$ref": "#/components/requestBodies/upsertWorkflowRule_request_body" } } }, "/workflow-rule/{id}": { "delete": { "operationId": "deleteWorkflowRule", "tags": [ "Workflow Rules" ], "description": "Delete a workflow rule", "responses": { "200": { "$ref": "#/components/responses/deleteWorkflowRule_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_workflow_rule_id_delete_parameters_0" } ] } }, "/invitation/pending": { "get": { "operationId": "getUserPendingInvitations", "tags": [ "Invitations" ], "description": "Get all pending invitations for the current user", "responses": { "200": { "$ref": "#/components/responses/getUserPendingInvitations_200_response" } } } }, "/invitation/{id}": { "get": { "operationId": "getInvitationDetails", "tags": [ "Invitations" ], "description": "Get details of a specific invitation by ID", "responses": { "200": { "$ref": "#/components/responses/getInvitationDetails_200_response" } }, "parameters": [ { "$ref": "#/components/parameters/id_path_spec_paths_invitation_id_get_parameters_0" } ] } }, "/sign-in/social": { "post": { "tags": [ "Default" ], "description": "Sign in with a social provider", "operationId": "socialSignIn", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/socialSignIn_request_body" }, "responses": { "200": { "$ref": "#/components/responses/socialSignIn_200_response" }, "400": { "$ref": "#/components/responses/socialSignIn_400_response" }, "401": { "$ref": "#/components/responses/socialSignIn_401_response" }, "403": { "$ref": "#/components/responses/socialSignIn_403_response" }, "404": { "$ref": "#/components/responses/socialSignIn_404_response" }, "429": { "$ref": "#/components/responses/socialSignIn_429_response" }, "500": { "$ref": "#/components/responses/socialSignIn_500_response" } } } }, "/callback/{id}": { "get": { "tags": [ "Default" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/get_callback_id_400_response" }, "401": { "$ref": "#/components/responses/get_callback_id_401_response" }, "403": { "$ref": "#/components/responses/get_callback_id_403_response" }, "404": { "$ref": "#/components/responses/get_callback_id_404_response" }, "429": { "$ref": "#/components/responses/get_callback_id_429_response" }, "500": { "$ref": "#/components/responses/get_callback_id_500_response" } } }, "post": { "tags": [ "Default" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_callback_id_request_body" }, "responses": { "400": { "$ref": "#/components/responses/post_callback_id_400_response" }, "401": { "$ref": "#/components/responses/post_callback_id_401_response" }, "403": { "$ref": "#/components/responses/post_callback_id_403_response" }, "404": { "$ref": "#/components/responses/post_callback_id_404_response" }, "429": { "$ref": "#/components/responses/post_callback_id_429_response" }, "500": { "$ref": "#/components/responses/post_callback_id_500_response" } } } }, "/get-session": { "get": { "tags": [ "Default" ], "description": "Get the current session", "operationId": "getSession", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/getSession_200_response" }, "400": { "$ref": "#/components/responses/getSession_400_response" }, "401": { "$ref": "#/components/responses/getSession_401_response" }, "403": { "$ref": "#/components/responses/getSession_403_response" }, "404": { "$ref": "#/components/responses/getSession_404_response" }, "429": { "$ref": "#/components/responses/getSession_429_response" }, "500": { "$ref": "#/components/responses/getSession_500_response" } } }, "post": { "tags": [ "Default" ], "description": "Get the current session", "operationId": "getSession_post_get-session", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/getSession_post_get_session_request_body" }, "responses": { "200": { "$ref": "#/components/responses/getSession_post_get_session_200_response" }, "400": { "$ref": "#/components/responses/getSession_post_get_session_400_response" }, "401": { "$ref": "#/components/responses/getSession_post_get_session_401_response" }, "403": { "$ref": "#/components/responses/getSession_post_get_session_403_response" }, "404": { "$ref": "#/components/responses/getSession_post_get_session_404_response" }, "429": { "$ref": "#/components/responses/getSession_post_get_session_429_response" }, "500": { "$ref": "#/components/responses/getSession_post_get_session_500_response" } } } }, "/sign-out": { "post": { "tags": [ "Default" ], "description": "Sign out the current user", "operationId": "signOut", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/signOut_request_body" }, "responses": { "200": { "$ref": "#/components/responses/signOut_200_response" }, "400": { "$ref": "#/components/responses/signOut_400_response" }, "401": { "$ref": "#/components/responses/signOut_401_response" }, "403": { "$ref": "#/components/responses/signOut_403_response" }, "404": { "$ref": "#/components/responses/signOut_404_response" }, "429": { "$ref": "#/components/responses/signOut_429_response" }, "500": { "$ref": "#/components/responses/signOut_500_response" } } } }, "/sign-up/email": { "post": { "tags": [ "Default" ], "description": "Sign up a user using email and password", "operationId": "signUpWithEmailAndPassword", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/signUpWithEmailAndPassword_request_body" }, "responses": { "200": { "$ref": "#/components/responses/signUpWithEmailAndPassword_200_response" }, "400": { "$ref": "#/components/responses/signUpWithEmailAndPassword_400_response" }, "401": { "$ref": "#/components/responses/signUpWithEmailAndPassword_401_response" }, "403": { "$ref": "#/components/responses/signUpWithEmailAndPassword_403_response" }, "404": { "$ref": "#/components/responses/signUpWithEmailAndPassword_404_response" }, "422": { "$ref": "#/components/responses/signUpWithEmailAndPassword_422_response" }, "429": { "$ref": "#/components/responses/signUpWithEmailAndPassword_429_response" }, "500": { "$ref": "#/components/responses/signUpWithEmailAndPassword_500_response" } } } }, "/sign-in/email": { "post": { "tags": [ "Default" ], "description": "Sign in with email and password", "operationId": "signInEmail", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/signInEmail_request_body" }, "responses": { "200": { "$ref": "#/components/responses/signInEmail_200_response" }, "400": { "$ref": "#/components/responses/signInEmail_400_response" }, "401": { "$ref": "#/components/responses/signInEmail_401_response" }, "403": { "$ref": "#/components/responses/signInEmail_403_response" }, "404": { "$ref": "#/components/responses/signInEmail_404_response" }, "429": { "$ref": "#/components/responses/signInEmail_429_response" }, "500": { "$ref": "#/components/responses/signInEmail_500_response" } } } }, "/reset-password": { "post": { "tags": [ "Default" ], "description": "Reset the password for a user", "operationId": "resetPassword", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/resetPassword_request_body" }, "responses": { "200": { "$ref": "#/components/responses/resetPassword_200_response" }, "400": { "$ref": "#/components/responses/resetPassword_400_response" }, "401": { "$ref": "#/components/responses/resetPassword_401_response" }, "403": { "$ref": "#/components/responses/resetPassword_403_response" }, "404": { "$ref": "#/components/responses/resetPassword_404_response" }, "429": { "$ref": "#/components/responses/resetPassword_429_response" }, "500": { "$ref": "#/components/responses/resetPassword_500_response" } } } }, "/verify-password": { "post": { "tags": [ "Default" ], "description": "Verify the current user's password", "operationId": "verifyPassword", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/verifyPassword_request_body" }, "responses": { "200": { "$ref": "#/components/responses/verifyPassword_200_response" }, "400": { "$ref": "#/components/responses/verifyPassword_400_response" }, "401": { "$ref": "#/components/responses/verifyPassword_401_response" }, "403": { "$ref": "#/components/responses/verifyPassword_403_response" }, "404": { "$ref": "#/components/responses/verifyPassword_404_response" }, "429": { "$ref": "#/components/responses/verifyPassword_429_response" }, "500": { "$ref": "#/components/responses/verifyPassword_500_response" } } } }, "/verify-email": { "get": { "tags": [ "Default" ], "description": "Verify the email of the user", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/token_query_spec_paths_verify_email_get_parameters_0" }, { "$ref": "#/components/parameters/callbackURL_query_spec_paths_verify_email_get_parameters_1" } ], "responses": { "200": { "$ref": "#/components/responses/get_verify_email_200_response" }, "400": { "$ref": "#/components/responses/get_verify_email_400_response" }, "401": { "$ref": "#/components/responses/get_verify_email_401_response" }, "403": { "$ref": "#/components/responses/get_verify_email_403_response" }, "404": { "$ref": "#/components/responses/get_verify_email_404_response" }, "429": { "$ref": "#/components/responses/get_verify_email_429_response" }, "500": { "$ref": "#/components/responses/get_verify_email_500_response" } } } }, "/send-verification-email": { "post": { "tags": [ "Default" ], "description": "Send a verification email to the user", "operationId": "sendVerificationEmail", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/sendVerificationEmail_request_body" }, "responses": { "200": { "$ref": "#/components/responses/sendVerificationEmail_200_response" }, "400": { "$ref": "#/components/responses/sendVerificationEmail_400_response" }, "401": { "$ref": "#/components/responses/sendVerificationEmail_401_response" }, "403": { "$ref": "#/components/responses/sendVerificationEmail_403_response" }, "404": { "$ref": "#/components/responses/sendVerificationEmail_404_response" }, "429": { "$ref": "#/components/responses/sendVerificationEmail_429_response" }, "500": { "$ref": "#/components/responses/sendVerificationEmail_500_response" } } } }, "/change-email": { "post": { "tags": [ "Default" ], "operationId": "changeEmail", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/changeEmail_request_body" }, "responses": { "200": { "$ref": "#/components/responses/changeEmail_200_response" }, "400": { "$ref": "#/components/responses/changeEmail_400_response" }, "401": { "$ref": "#/components/responses/changeEmail_401_response" }, "403": { "$ref": "#/components/responses/changeEmail_403_response" }, "404": { "$ref": "#/components/responses/changeEmail_404_response" }, "429": { "$ref": "#/components/responses/changeEmail_429_response" }, "500": { "$ref": "#/components/responses/changeEmail_500_response" } } } }, "/change-password": { "post": { "tags": [ "Default" ], "description": "Change the password of the user", "operationId": "changePassword", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/changePassword_request_body" }, "responses": { "200": { "$ref": "#/components/responses/changePassword_200_response" }, "400": { "$ref": "#/components/responses/changePassword_400_response" }, "401": { "$ref": "#/components/responses/changePassword_401_response" }, "403": { "$ref": "#/components/responses/changePassword_403_response" }, "404": { "$ref": "#/components/responses/changePassword_404_response" }, "429": { "$ref": "#/components/responses/changePassword_429_response" }, "500": { "$ref": "#/components/responses/changePassword_500_response" } } } }, "/update-session": { "post": { "tags": [ "Default" ], "description": "Update the current session", "operationId": "updateSession", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/updateSession_request_body" }, "responses": { "200": { "$ref": "#/components/responses/updateSession_200_response" }, "400": { "$ref": "#/components/responses/updateSession_400_response" }, "401": { "$ref": "#/components/responses/updateSession_401_response" }, "403": { "$ref": "#/components/responses/updateSession_403_response" }, "404": { "$ref": "#/components/responses/updateSession_404_response" }, "429": { "$ref": "#/components/responses/updateSession_429_response" }, "500": { "$ref": "#/components/responses/updateSession_500_response" } } } }, "/update-user": { "post": { "tags": [ "Default" ], "description": "Update the current user", "operationId": "updateUser", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/updateUser_request_body" }, "responses": { "200": { "$ref": "#/components/responses/updateUser_200_response" }, "400": { "$ref": "#/components/responses/updateUser_400_response" }, "401": { "$ref": "#/components/responses/updateUser_401_response" }, "403": { "$ref": "#/components/responses/updateUser_403_response" }, "404": { "$ref": "#/components/responses/updateUser_404_response" }, "429": { "$ref": "#/components/responses/updateUser_429_response" }, "500": { "$ref": "#/components/responses/updateUser_500_response" } } } }, "/delete-user": { "post": { "tags": [ "Default" ], "description": "Delete the user", "operationId": "deleteUser", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/deleteUser_request_body" }, "responses": { "200": { "$ref": "#/components/responses/deleteUser_200_response" }, "400": { "$ref": "#/components/responses/deleteUser_400_response" }, "401": { "$ref": "#/components/responses/deleteUser_401_response" }, "403": { "$ref": "#/components/responses/deleteUser_403_response" }, "404": { "$ref": "#/components/responses/deleteUser_404_response" }, "429": { "$ref": "#/components/responses/deleteUser_429_response" }, "500": { "$ref": "#/components/responses/deleteUser_500_response" } } } }, "/request-password-reset": { "post": { "tags": [ "Default" ], "description": "Send a password reset email to the user", "operationId": "requestPasswordReset", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/requestPasswordReset_request_body" }, "responses": { "200": { "$ref": "#/components/responses/requestPasswordReset_200_response" }, "400": { "$ref": "#/components/responses/requestPasswordReset_400_response" }, "401": { "$ref": "#/components/responses/requestPasswordReset_401_response" }, "403": { "$ref": "#/components/responses/requestPasswordReset_403_response" }, "404": { "$ref": "#/components/responses/requestPasswordReset_404_response" }, "429": { "$ref": "#/components/responses/requestPasswordReset_429_response" }, "500": { "$ref": "#/components/responses/requestPasswordReset_500_response" } } } }, "/reset-password/{token}": { "get": { "tags": [ "Default" ], "description": "Redirects the user to the callback URL with the token", "operationId": "resetPasswordCallback", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/token_path_spec_paths_reset_password_token_get_parameters_0" }, { "$ref": "#/components/parameters/callbackURL_query_spec_paths_reset_password_token_get_parameters_1" } ], "responses": { "200": { "$ref": "#/components/responses/resetPasswordCallback_200_response" }, "400": { "$ref": "#/components/responses/resetPasswordCallback_400_response" }, "401": { "$ref": "#/components/responses/resetPasswordCallback_401_response" }, "403": { "$ref": "#/components/responses/resetPasswordCallback_403_response" }, "404": { "$ref": "#/components/responses/resetPasswordCallback_404_response" }, "429": { "$ref": "#/components/responses/resetPasswordCallback_429_response" }, "500": { "$ref": "#/components/responses/resetPasswordCallback_500_response" } } } }, "/list-sessions": { "get": { "tags": [ "Default" ], "description": "List all active sessions for the user", "operationId": "listUserSessions", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/listUserSessions_200_response" }, "400": { "$ref": "#/components/responses/listUserSessions_400_response" }, "401": { "$ref": "#/components/responses/listUserSessions_401_response" }, "403": { "$ref": "#/components/responses/listUserSessions_403_response" }, "404": { "$ref": "#/components/responses/listUserSessions_404_response" }, "429": { "$ref": "#/components/responses/listUserSessions_429_response" }, "500": { "$ref": "#/components/responses/listUserSessions_500_response" } } } }, "/revoke-session": { "post": { "tags": [ "Default" ], "description": "Revoke a single session", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_revoke_session_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_revoke_session_200_response" }, "400": { "$ref": "#/components/responses/post_revoke_session_400_response" }, "401": { "$ref": "#/components/responses/post_revoke_session_401_response" }, "403": { "$ref": "#/components/responses/post_revoke_session_403_response" }, "404": { "$ref": "#/components/responses/post_revoke_session_404_response" }, "429": { "$ref": "#/components/responses/post_revoke_session_429_response" }, "500": { "$ref": "#/components/responses/post_revoke_session_500_response" } } } }, "/revoke-sessions": { "post": { "tags": [ "Default" ], "description": "Revoke all sessions for the user", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_revoke_sessions_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_revoke_sessions_200_response" }, "400": { "$ref": "#/components/responses/post_revoke_sessions_400_response" }, "401": { "$ref": "#/components/responses/post_revoke_sessions_401_response" }, "403": { "$ref": "#/components/responses/post_revoke_sessions_403_response" }, "404": { "$ref": "#/components/responses/post_revoke_sessions_404_response" }, "429": { "$ref": "#/components/responses/post_revoke_sessions_429_response" }, "500": { "$ref": "#/components/responses/post_revoke_sessions_500_response" } } } }, "/revoke-other-sessions": { "post": { "tags": [ "Default" ], "description": "Revoke all other sessions for the user except the current one", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_revoke_other_sessions_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_revoke_other_sessions_200_response" }, "400": { "$ref": "#/components/responses/post_revoke_other_sessions_400_response" }, "401": { "$ref": "#/components/responses/post_revoke_other_sessions_401_response" }, "403": { "$ref": "#/components/responses/post_revoke_other_sessions_403_response" }, "404": { "$ref": "#/components/responses/post_revoke_other_sessions_404_response" }, "429": { "$ref": "#/components/responses/post_revoke_other_sessions_429_response" }, "500": { "$ref": "#/components/responses/post_revoke_other_sessions_500_response" } } } }, "/link-social": { "post": { "tags": [ "Default" ], "description": "Link a social account to the user", "operationId": "linkSocialAccount", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/linkSocialAccount_request_body" }, "responses": { "200": { "$ref": "#/components/responses/linkSocialAccount_200_response" }, "400": { "$ref": "#/components/responses/linkSocialAccount_400_response" }, "401": { "$ref": "#/components/responses/linkSocialAccount_401_response" }, "403": { "$ref": "#/components/responses/linkSocialAccount_403_response" }, "404": { "$ref": "#/components/responses/linkSocialAccount_404_response" }, "429": { "$ref": "#/components/responses/linkSocialAccount_429_response" }, "500": { "$ref": "#/components/responses/linkSocialAccount_500_response" } } } }, "/list-accounts": { "get": { "tags": [ "Default" ], "description": "List all accounts linked to the user", "operationId": "listUserAccounts", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/listUserAccounts_200_response" }, "400": { "$ref": "#/components/responses/listUserAccounts_400_response" }, "401": { "$ref": "#/components/responses/listUserAccounts_401_response" }, "403": { "$ref": "#/components/responses/listUserAccounts_403_response" }, "404": { "$ref": "#/components/responses/listUserAccounts_404_response" }, "429": { "$ref": "#/components/responses/listUserAccounts_429_response" }, "500": { "$ref": "#/components/responses/listUserAccounts_500_response" } } } }, "/delete-user/callback": { "get": { "tags": [ "Default" ], "description": "Callback to complete user deletion with verification token", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/token_query_spec_paths_delete_user_callback_get_parameters_0" }, { "$ref": "#/components/parameters/callbackURL_query_spec_paths_delete_user_callback_get_parameters_1" } ], "responses": { "200": { "$ref": "#/components/responses/get_delete_user_callback_200_response" }, "400": { "$ref": "#/components/responses/get_delete_user_callback_400_response" }, "401": { "$ref": "#/components/responses/get_delete_user_callback_401_response" }, "403": { "$ref": "#/components/responses/get_delete_user_callback_403_response" }, "404": { "$ref": "#/components/responses/get_delete_user_callback_404_response" }, "429": { "$ref": "#/components/responses/get_delete_user_callback_429_response" }, "500": { "$ref": "#/components/responses/get_delete_user_callback_500_response" } } } }, "/unlink-account": { "post": { "tags": [ "Default" ], "description": "Unlink an account", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_unlink_account_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_unlink_account_200_response" }, "400": { "$ref": "#/components/responses/post_unlink_account_400_response" }, "401": { "$ref": "#/components/responses/post_unlink_account_401_response" }, "403": { "$ref": "#/components/responses/post_unlink_account_403_response" }, "404": { "$ref": "#/components/responses/post_unlink_account_404_response" }, "429": { "$ref": "#/components/responses/post_unlink_account_429_response" }, "500": { "$ref": "#/components/responses/post_unlink_account_500_response" } } } }, "/refresh-token": { "post": { "tags": [ "Default" ], "description": "Refresh the access token using a refresh token", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_refresh_token_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_refresh_token_200_response" }, "400": { "$ref": "#/components/responses/post_refresh_token_400_response" }, "401": { "$ref": "#/components/responses/post_refresh_token_401_response" }, "403": { "$ref": "#/components/responses/post_refresh_token_403_response" }, "404": { "$ref": "#/components/responses/post_refresh_token_404_response" }, "429": { "$ref": "#/components/responses/post_refresh_token_429_response" }, "500": { "$ref": "#/components/responses/post_refresh_token_500_response" } } } }, "/get-access-token": { "post": { "tags": [ "Default" ], "description": "Get a valid access token, doing a refresh if needed", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_get_access_token_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_get_access_token_200_response" }, "400": { "$ref": "#/components/responses/post_get_access_token_400_response" }, "401": { "$ref": "#/components/responses/post_get_access_token_401_response" }, "403": { "$ref": "#/components/responses/post_get_access_token_403_response" }, "404": { "$ref": "#/components/responses/post_get_access_token_404_response" }, "429": { "$ref": "#/components/responses/post_get_access_token_429_response" }, "500": { "$ref": "#/components/responses/post_get_access_token_500_response" } } } }, "/account-info": { "get": { "tags": [ "Default" ], "description": "Get the account info provided by the provider", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_account_info_200_response" }, "400": { "$ref": "#/components/responses/get_account_info_400_response" }, "401": { "$ref": "#/components/responses/get_account_info_401_response" }, "403": { "$ref": "#/components/responses/get_account_info_403_response" }, "404": { "$ref": "#/components/responses/get_account_info_404_response" }, "429": { "$ref": "#/components/responses/get_account_info_429_response" }, "500": { "$ref": "#/components/responses/get_account_info_500_response" } } } }, "/ok": { "get": { "tags": [ "Default" ], "description": "Check if the API is working", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_ok_200_response" }, "400": { "$ref": "#/components/responses/get_ok_400_response" }, "401": { "$ref": "#/components/responses/get_ok_401_response" }, "403": { "$ref": "#/components/responses/get_ok_403_response" }, "404": { "$ref": "#/components/responses/get_ok_404_response" }, "429": { "$ref": "#/components/responses/get_ok_429_response" }, "500": { "$ref": "#/components/responses/get_ok_500_response" } } } }, "/error": { "get": { "tags": [ "Default" ], "description": "Displays an error page", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_error_200_response" }, "400": { "$ref": "#/components/responses/get_error_400_response" }, "401": { "$ref": "#/components/responses/get_error_401_response" }, "403": { "$ref": "#/components/responses/get_error_403_response" }, "404": { "$ref": "#/components/responses/get_error_404_response" }, "429": { "$ref": "#/components/responses/get_error_429_response" }, "500": { "$ref": "#/components/responses/get_error_500_response" } } } }, "/sign-in/anonymous": { "post": { "tags": [ "Anonymous" ], "description": "Sign in anonymously", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/post_sign_in_anonymous_200_response" }, "400": { "$ref": "#/components/responses/post_sign_in_anonymous_400_response" }, "401": { "$ref": "#/components/responses/post_sign_in_anonymous_401_response" }, "403": { "$ref": "#/components/responses/post_sign_in_anonymous_403_response" }, "404": { "$ref": "#/components/responses/post_sign_in_anonymous_404_response" }, "429": { "$ref": "#/components/responses/post_sign_in_anonymous_429_response" }, "500": { "$ref": "#/components/responses/post_sign_in_anonymous_500_response" } } } }, "/delete-anonymous-user": { "post": { "tags": [ "Anonymous" ], "description": "Delete an anonymous user", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/post_delete_anonymous_user_200_response" }, "400": { "$ref": "#/components/responses/post_delete_anonymous_user_400_response" }, "401": { "$ref": "#/components/responses/post_delete_anonymous_user_401_response" }, "403": { "$ref": "#/components/responses/post_delete_anonymous_user_403_response" }, "404": { "$ref": "#/components/responses/post_delete_anonymous_user_404_response" }, "429": { "$ref": "#/components/responses/post_delete_anonymous_user_429_response" }, "500": { "$ref": "#/components/responses/post_delete_anonymous_user_500_response" } } } }, "/sign-in/magic-link": { "post": { "tags": [ "Magic-link" ], "description": "Sign in with magic link", "operationId": "signInWithMagicLink", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/signInWithMagicLink_request_body" }, "responses": { "200": { "$ref": "#/components/responses/signInWithMagicLink_200_response" }, "400": { "$ref": "#/components/responses/signInWithMagicLink_400_response" }, "401": { "$ref": "#/components/responses/signInWithMagicLink_401_response" }, "403": { "$ref": "#/components/responses/signInWithMagicLink_403_response" }, "404": { "$ref": "#/components/responses/signInWithMagicLink_404_response" }, "429": { "$ref": "#/components/responses/signInWithMagicLink_429_response" }, "500": { "$ref": "#/components/responses/signInWithMagicLink_500_response" } } } }, "/magic-link/verify": { "get": { "tags": [ "Magic-link" ], "description": "Verify magic link", "operationId": "verifyMagicLink", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/token_query_spec_paths_magic_link_verify_get_parameters_0" }, { "$ref": "#/components/parameters/callbackURL_query_spec_paths_magic_link_verify_get_parameters_1" }, { "$ref": "#/components/parameters/errorCallbackURL_query_spec_paths_magic_link_verify_get_parameters_2" }, { "$ref": "#/components/parameters/newUserCallbackURL_query_spec_paths_magic_link_verify_get_parameters_3" } ], "responses": { "200": { "$ref": "#/components/responses/verifyMagicLink_200_response" }, "400": { "$ref": "#/components/responses/verifyMagicLink_400_response" }, "401": { "$ref": "#/components/responses/verifyMagicLink_401_response" }, "403": { "$ref": "#/components/responses/verifyMagicLink_403_response" }, "404": { "$ref": "#/components/responses/verifyMagicLink_404_response" }, "429": { "$ref": "#/components/responses/verifyMagicLink_429_response" }, "500": { "$ref": "#/components/responses/verifyMagicLink_500_response" } } } }, "/email-otp/send-verification-otp": { "post": { "tags": [ "Email-otp" ], "description": "Send a verification OTP to an email", "operationId": "sendEmailVerificationOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/sendEmailVerificationOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/sendEmailVerificationOTP_200_response" }, "400": { "$ref": "#/components/responses/sendEmailVerificationOTP_400_response" }, "401": { "$ref": "#/components/responses/sendEmailVerificationOTP_401_response" }, "403": { "$ref": "#/components/responses/sendEmailVerificationOTP_403_response" }, "404": { "$ref": "#/components/responses/sendEmailVerificationOTP_404_response" }, "429": { "$ref": "#/components/responses/sendEmailVerificationOTP_429_response" }, "500": { "$ref": "#/components/responses/sendEmailVerificationOTP_500_response" } } } }, "/email-otp/check-verification-otp": { "post": { "tags": [ "Email-otp" ], "description": "Verify an email with an OTP", "operationId": "verifyEmailWithOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/verifyEmailWithOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/verifyEmailWithOTP_200_response" }, "400": { "$ref": "#/components/responses/verifyEmailWithOTP_400_response" }, "401": { "$ref": "#/components/responses/verifyEmailWithOTP_401_response" }, "403": { "$ref": "#/components/responses/verifyEmailWithOTP_403_response" }, "404": { "$ref": "#/components/responses/verifyEmailWithOTP_404_response" }, "429": { "$ref": "#/components/responses/verifyEmailWithOTP_429_response" }, "500": { "$ref": "#/components/responses/verifyEmailWithOTP_500_response" } } } }, "/email-otp/verify-email": { "post": { "tags": [ "Email-otp" ], "description": "Verify email with OTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_email_otp_verify_email_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_email_otp_verify_email_200_response" }, "400": { "$ref": "#/components/responses/post_email_otp_verify_email_400_response" }, "401": { "$ref": "#/components/responses/post_email_otp_verify_email_401_response" }, "403": { "$ref": "#/components/responses/post_email_otp_verify_email_403_response" }, "404": { "$ref": "#/components/responses/post_email_otp_verify_email_404_response" }, "429": { "$ref": "#/components/responses/post_email_otp_verify_email_429_response" }, "500": { "$ref": "#/components/responses/post_email_otp_verify_email_500_response" } } } }, "/sign-in/email-otp": { "post": { "tags": [ "Email-otp" ], "description": "Sign in with email and OTP", "operationId": "signInWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/signInWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/signInWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/signInWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/signInWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/signInWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/signInWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/signInWithEmailOTP_500_response" } } } }, "/email-otp/request-password-reset": { "post": { "tags": [ "Email-otp" ], "description": "Request password reset with email and OTP", "operationId": "requestPasswordResetWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/requestPasswordResetWithEmailOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/requestPasswordResetWithEmailOTP_500_response" } } } }, "/forget-password/email-otp": { "post": { "tags": [ "Email-otp" ], "description": "Deprecated: Use /email-otp/request-password-reset instead.", "operationId": "forgetPasswordWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/forgetPasswordWithEmailOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/forgetPasswordWithEmailOTP_500_response" } } } }, "/email-otp/reset-password": { "post": { "tags": [ "Email-otp" ], "description": "Reset password with email and OTP", "operationId": "resetPasswordWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/resetPasswordWithEmailOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/resetPasswordWithEmailOTP_500_response" } } } }, "/email-otp/request-email-change": { "post": { "tags": [ "Email-otp" ], "description": "Request email change with verification OTP sent to the new email", "operationId": "requestEmailChangeWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/requestEmailChangeWithEmailOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/requestEmailChangeWithEmailOTP_500_response" } } } }, "/email-otp/change-email": { "post": { "tags": [ "Email-otp" ], "description": "Verify new email with OTP and change the email if verification is successful", "operationId": "changeEmailWithEmailOTP", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/changeEmailWithEmailOTP_request_body" }, "responses": { "200": { "$ref": "#/components/responses/changeEmailWithEmailOTP_200_response" }, "400": { "$ref": "#/components/responses/changeEmailWithEmailOTP_400_response" }, "401": { "$ref": "#/components/responses/changeEmailWithEmailOTP_401_response" }, "403": { "$ref": "#/components/responses/changeEmailWithEmailOTP_403_response" }, "404": { "$ref": "#/components/responses/changeEmailWithEmailOTP_404_response" }, "429": { "$ref": "#/components/responses/changeEmailWithEmailOTP_429_response" }, "500": { "$ref": "#/components/responses/changeEmailWithEmailOTP_500_response" } } } }, "/organization/create": { "post": { "tags": [ "Organization" ], "description": "Create an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_create_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_create_200_response" }, "400": { "$ref": "#/components/responses/post_organization_create_400_response" }, "401": { "$ref": "#/components/responses/post_organization_create_401_response" }, "403": { "$ref": "#/components/responses/post_organization_create_403_response" }, "404": { "$ref": "#/components/responses/post_organization_create_404_response" }, "429": { "$ref": "#/components/responses/post_organization_create_429_response" }, "500": { "$ref": "#/components/responses/post_organization_create_500_response" } } } }, "/organization/update": { "post": { "tags": [ "Organization" ], "description": "Update an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_update_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_update_200_response" }, "400": { "$ref": "#/components/responses/post_organization_update_400_response" }, "401": { "$ref": "#/components/responses/post_organization_update_401_response" }, "403": { "$ref": "#/components/responses/post_organization_update_403_response" }, "404": { "$ref": "#/components/responses/post_organization_update_404_response" }, "429": { "$ref": "#/components/responses/post_organization_update_429_response" }, "500": { "$ref": "#/components/responses/post_organization_update_500_response" } } } }, "/organization/delete": { "post": { "tags": [ "Organization" ], "description": "Delete an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_delete_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_delete_200_response" }, "400": { "$ref": "#/components/responses/post_organization_delete_400_response" }, "401": { "$ref": "#/components/responses/post_organization_delete_401_response" }, "403": { "$ref": "#/components/responses/post_organization_delete_403_response" }, "404": { "$ref": "#/components/responses/post_organization_delete_404_response" }, "429": { "$ref": "#/components/responses/post_organization_delete_429_response" }, "500": { "$ref": "#/components/responses/post_organization_delete_500_response" } } } }, "/organization/set-active": { "post": { "tags": [ "Organization" ], "description": "Set the active organization", "operationId": "setActiveOrganization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/setActiveOrganization_request_body" }, "responses": { "200": { "$ref": "#/components/responses/setActiveOrganization_200_response" }, "400": { "$ref": "#/components/responses/setActiveOrganization_400_response" }, "401": { "$ref": "#/components/responses/setActiveOrganization_401_response" }, "403": { "$ref": "#/components/responses/setActiveOrganization_403_response" }, "404": { "$ref": "#/components/responses/setActiveOrganization_404_response" }, "429": { "$ref": "#/components/responses/setActiveOrganization_429_response" }, "500": { "$ref": "#/components/responses/setActiveOrganization_500_response" } } } }, "/organization/get-full-organization": { "get": { "tags": [ "Organization" ], "description": "Get the full organization", "operationId": "getOrganization", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/getOrganization_200_response" }, "400": { "$ref": "#/components/responses/getOrganization_400_response" }, "401": { "$ref": "#/components/responses/getOrganization_401_response" }, "403": { "$ref": "#/components/responses/getOrganization_403_response" }, "404": { "$ref": "#/components/responses/getOrganization_404_response" }, "429": { "$ref": "#/components/responses/getOrganization_429_response" }, "500": { "$ref": "#/components/responses/getOrganization_500_response" } } } }, "/organization/list": { "get": { "tags": [ "Organization" ], "description": "List all organizations", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_list_200_response" }, "400": { "$ref": "#/components/responses/get_organization_list_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_500_response" } } } }, "/organization/invite-member": { "post": { "tags": [ "Organization" ], "description": "Create an invitation to an organization", "operationId": "createOrganizationInvitation", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/createOrganizationInvitation_request_body" }, "responses": { "200": { "$ref": "#/components/responses/createOrganizationInvitation_200_response" }, "400": { "$ref": "#/components/responses/createOrganizationInvitation_400_response" }, "401": { "$ref": "#/components/responses/createOrganizationInvitation_401_response" }, "403": { "$ref": "#/components/responses/createOrganizationInvitation_403_response" }, "404": { "$ref": "#/components/responses/createOrganizationInvitation_404_response" }, "429": { "$ref": "#/components/responses/createOrganizationInvitation_429_response" }, "500": { "$ref": "#/components/responses/createOrganizationInvitation_500_response" } } } }, "/organization/cancel-invitation": { "post": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_cancel_invitation_request_body" }, "responses": { "400": { "$ref": "#/components/responses/post_organization_cancel_invitation_400_response" }, "401": { "$ref": "#/components/responses/post_organization_cancel_invitation_401_response" }, "403": { "$ref": "#/components/responses/post_organization_cancel_invitation_403_response" }, "404": { "$ref": "#/components/responses/post_organization_cancel_invitation_404_response" }, "429": { "$ref": "#/components/responses/post_organization_cancel_invitation_429_response" }, "500": { "$ref": "#/components/responses/post_organization_cancel_invitation_500_response" } } } }, "/organization/accept-invitation": { "post": { "tags": [ "Organization" ], "description": "Accept an invitation to an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_accept_invitation_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_accept_invitation_200_response" }, "400": { "$ref": "#/components/responses/post_organization_accept_invitation_400_response" }, "401": { "$ref": "#/components/responses/post_organization_accept_invitation_401_response" }, "403": { "$ref": "#/components/responses/post_organization_accept_invitation_403_response" }, "404": { "$ref": "#/components/responses/post_organization_accept_invitation_404_response" }, "429": { "$ref": "#/components/responses/post_organization_accept_invitation_429_response" }, "500": { "$ref": "#/components/responses/post_organization_accept_invitation_500_response" } } } }, "/organization/get-invitation": { "get": { "tags": [ "Organization" ], "description": "Get an invitation by ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/id_query_spec_paths_organization_get_invitation_get_parameters_0" } ], "responses": { "200": { "$ref": "#/components/responses/get_organization_get_invitation_200_response" }, "400": { "$ref": "#/components/responses/get_organization_get_invitation_400_response" }, "401": { "$ref": "#/components/responses/get_organization_get_invitation_401_response" }, "403": { "$ref": "#/components/responses/get_organization_get_invitation_403_response" }, "404": { "$ref": "#/components/responses/get_organization_get_invitation_404_response" }, "429": { "$ref": "#/components/responses/get_organization_get_invitation_429_response" }, "500": { "$ref": "#/components/responses/get_organization_get_invitation_500_response" } } } }, "/organization/reject-invitation": { "post": { "tags": [ "Organization" ], "description": "Reject an invitation to an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_reject_invitation_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_reject_invitation_200_response" }, "400": { "$ref": "#/components/responses/post_organization_reject_invitation_400_response" }, "401": { "$ref": "#/components/responses/post_organization_reject_invitation_401_response" }, "403": { "$ref": "#/components/responses/post_organization_reject_invitation_403_response" }, "404": { "$ref": "#/components/responses/post_organization_reject_invitation_404_response" }, "429": { "$ref": "#/components/responses/post_organization_reject_invitation_429_response" }, "500": { "$ref": "#/components/responses/post_organization_reject_invitation_500_response" } } } }, "/organization/list-invitations": { "get": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/get_organization_list_invitations_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_invitations_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_invitations_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_invitations_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_invitations_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_invitations_500_response" } } } }, "/organization/get-active-member": { "get": { "tags": [ "Organization" ], "description": "Get the member details of the active organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_get_active_member_200_response" }, "400": { "$ref": "#/components/responses/get_organization_get_active_member_400_response" }, "401": { "$ref": "#/components/responses/get_organization_get_active_member_401_response" }, "403": { "$ref": "#/components/responses/get_organization_get_active_member_403_response" }, "404": { "$ref": "#/components/responses/get_organization_get_active_member_404_response" }, "429": { "$ref": "#/components/responses/get_organization_get_active_member_429_response" }, "500": { "$ref": "#/components/responses/get_organization_get_active_member_500_response" } } } }, "/organization/check-slug": { "post": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_check_slug_request_body" }, "responses": { "400": { "$ref": "#/components/responses/post_organization_check_slug_400_response" }, "401": { "$ref": "#/components/responses/post_organization_check_slug_401_response" }, "403": { "$ref": "#/components/responses/post_organization_check_slug_403_response" }, "404": { "$ref": "#/components/responses/post_organization_check_slug_404_response" }, "429": { "$ref": "#/components/responses/post_organization_check_slug_429_response" }, "500": { "$ref": "#/components/responses/post_organization_check_slug_500_response" } } } }, "/organization/remove-member": { "post": { "tags": [ "Organization" ], "description": "Remove a member from an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_remove_member_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_remove_member_200_response" }, "400": { "$ref": "#/components/responses/post_organization_remove_member_400_response" }, "401": { "$ref": "#/components/responses/post_organization_remove_member_401_response" }, "403": { "$ref": "#/components/responses/post_organization_remove_member_403_response" }, "404": { "$ref": "#/components/responses/post_organization_remove_member_404_response" }, "429": { "$ref": "#/components/responses/post_organization_remove_member_429_response" }, "500": { "$ref": "#/components/responses/post_organization_remove_member_500_response" } } } }, "/organization/update-member-role": { "post": { "tags": [ "Organization" ], "description": "Update the role of a member in an organization", "operationId": "updateOrganizationMemberRole", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/updateOrganizationMemberRole_request_body" }, "responses": { "200": { "$ref": "#/components/responses/updateOrganizationMemberRole_200_response" }, "400": { "$ref": "#/components/responses/updateOrganizationMemberRole_400_response" }, "401": { "$ref": "#/components/responses/updateOrganizationMemberRole_401_response" }, "403": { "$ref": "#/components/responses/updateOrganizationMemberRole_403_response" }, "404": { "$ref": "#/components/responses/updateOrganizationMemberRole_404_response" }, "429": { "$ref": "#/components/responses/updateOrganizationMemberRole_429_response" }, "500": { "$ref": "#/components/responses/updateOrganizationMemberRole_500_response" } } } }, "/organization/leave": { "post": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_leave_request_body" }, "responses": { "400": { "$ref": "#/components/responses/post_organization_leave_400_response" }, "401": { "$ref": "#/components/responses/post_organization_leave_401_response" }, "403": { "$ref": "#/components/responses/post_organization_leave_403_response" }, "404": { "$ref": "#/components/responses/post_organization_leave_404_response" }, "429": { "$ref": "#/components/responses/post_organization_leave_429_response" }, "500": { "$ref": "#/components/responses/post_organization_leave_500_response" } } } }, "/organization/list-user-invitations": { "get": { "tags": [ "Organization" ], "description": "List all invitations a user has received", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_list_user_invitations_200_response" }, "400": { "$ref": "#/components/responses/get_organization_list_user_invitations_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_user_invitations_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_user_invitations_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_user_invitations_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_user_invitations_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_user_invitations_500_response" } } } }, "/organization/list-members": { "get": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/get_organization_list_members_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_members_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_members_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_members_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_members_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_members_500_response" } } } }, "/organization/get-active-member-role": { "get": { "tags": [ "Organization" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/get_organization_get_active_member_role_400_response" }, "401": { "$ref": "#/components/responses/get_organization_get_active_member_role_401_response" }, "403": { "$ref": "#/components/responses/get_organization_get_active_member_role_403_response" }, "404": { "$ref": "#/components/responses/get_organization_get_active_member_role_404_response" }, "429": { "$ref": "#/components/responses/get_organization_get_active_member_role_429_response" }, "500": { "$ref": "#/components/responses/get_organization_get_active_member_role_500_response" } } } }, "/organization/create-team": { "post": { "tags": [ "Organization" ], "description": "Create a new team within an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_create_team_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_create_team_200_response" }, "400": { "$ref": "#/components/responses/post_organization_create_team_400_response" }, "401": { "$ref": "#/components/responses/post_organization_create_team_401_response" }, "403": { "$ref": "#/components/responses/post_organization_create_team_403_response" }, "404": { "$ref": "#/components/responses/post_organization_create_team_404_response" }, "429": { "$ref": "#/components/responses/post_organization_create_team_429_response" }, "500": { "$ref": "#/components/responses/post_organization_create_team_500_response" } } } }, "/organization/list-teams": { "get": { "tags": [ "Organization" ], "description": "List all teams in an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_list_teams_200_response" }, "400": { "$ref": "#/components/responses/get_organization_list_teams_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_teams_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_teams_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_teams_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_teams_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_teams_500_response" } } } }, "/organization/remove-team": { "post": { "tags": [ "Organization" ], "description": "Remove a team from an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_remove_team_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_remove_team_200_response" }, "400": { "$ref": "#/components/responses/post_organization_remove_team_400_response" }, "401": { "$ref": "#/components/responses/post_organization_remove_team_401_response" }, "403": { "$ref": "#/components/responses/post_organization_remove_team_403_response" }, "404": { "$ref": "#/components/responses/post_organization_remove_team_404_response" }, "429": { "$ref": "#/components/responses/post_organization_remove_team_429_response" }, "500": { "$ref": "#/components/responses/post_organization_remove_team_500_response" } } } }, "/organization/update-team": { "post": { "tags": [ "Organization" ], "description": "Update an existing team in an organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_update_team_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_update_team_200_response" }, "400": { "$ref": "#/components/responses/post_organization_update_team_400_response" }, "401": { "$ref": "#/components/responses/post_organization_update_team_401_response" }, "403": { "$ref": "#/components/responses/post_organization_update_team_403_response" }, "404": { "$ref": "#/components/responses/post_organization_update_team_404_response" }, "429": { "$ref": "#/components/responses/post_organization_update_team_429_response" }, "500": { "$ref": "#/components/responses/post_organization_update_team_500_response" } } } }, "/organization/set-active-team": { "post": { "tags": [ "Organization" ], "description": "Set the active team", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_set_active_team_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_set_active_team_200_response" }, "400": { "$ref": "#/components/responses/post_organization_set_active_team_400_response" }, "401": { "$ref": "#/components/responses/post_organization_set_active_team_401_response" }, "403": { "$ref": "#/components/responses/post_organization_set_active_team_403_response" }, "404": { "$ref": "#/components/responses/post_organization_set_active_team_404_response" }, "429": { "$ref": "#/components/responses/post_organization_set_active_team_429_response" }, "500": { "$ref": "#/components/responses/post_organization_set_active_team_500_response" } } } }, "/organization/list-user-teams": { "get": { "tags": [ "Organization" ], "description": "List all teams that the current user is a part of.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_list_user_teams_200_response" }, "400": { "$ref": "#/components/responses/get_organization_list_user_teams_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_user_teams_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_user_teams_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_user_teams_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_user_teams_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_user_teams_500_response" } } } }, "/organization/list-team-members": { "get": { "tags": [ "Organization" ], "description": "List the members of the given team.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_organization_list_team_members_200_response" }, "400": { "$ref": "#/components/responses/get_organization_list_team_members_400_response" }, "401": { "$ref": "#/components/responses/get_organization_list_team_members_401_response" }, "403": { "$ref": "#/components/responses/get_organization_list_team_members_403_response" }, "404": { "$ref": "#/components/responses/get_organization_list_team_members_404_response" }, "429": { "$ref": "#/components/responses/get_organization_list_team_members_429_response" }, "500": { "$ref": "#/components/responses/get_organization_list_team_members_500_response" } } } }, "/organization/add-team-member": { "post": { "tags": [ "Organization" ], "description": "The newly created member", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_add_team_member_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_add_team_member_200_response" }, "400": { "$ref": "#/components/responses/post_organization_add_team_member_400_response" }, "401": { "$ref": "#/components/responses/post_organization_add_team_member_401_response" }, "403": { "$ref": "#/components/responses/post_organization_add_team_member_403_response" }, "404": { "$ref": "#/components/responses/post_organization_add_team_member_404_response" }, "429": { "$ref": "#/components/responses/post_organization_add_team_member_429_response" }, "500": { "$ref": "#/components/responses/post_organization_add_team_member_500_response" } } } }, "/organization/remove-team-member": { "post": { "tags": [ "Organization" ], "description": "Remove a member from a team", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_remove_team_member_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_remove_team_member_200_response" }, "400": { "$ref": "#/components/responses/post_organization_remove_team_member_400_response" }, "401": { "$ref": "#/components/responses/post_organization_remove_team_member_401_response" }, "403": { "$ref": "#/components/responses/post_organization_remove_team_member_403_response" }, "404": { "$ref": "#/components/responses/post_organization_remove_team_member_404_response" }, "429": { "$ref": "#/components/responses/post_organization_remove_team_member_429_response" }, "500": { "$ref": "#/components/responses/post_organization_remove_team_member_500_response" } } } }, "/organization/has-permission": { "post": { "tags": [ "Organization" ], "description": "Check if the user has permission", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_organization_has_permission_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_organization_has_permission_200_response" }, "400": { "$ref": "#/components/responses/post_organization_has_permission_400_response" }, "401": { "$ref": "#/components/responses/post_organization_has_permission_401_response" }, "403": { "$ref": "#/components/responses/post_organization_has_permission_403_response" }, "404": { "$ref": "#/components/responses/post_organization_has_permission_404_response" }, "429": { "$ref": "#/components/responses/post_organization_has_permission_429_response" }, "500": { "$ref": "#/components/responses/post_organization_has_permission_500_response" } } } }, "/sign-in/oauth2": { "post": { "tags": [ "Generic-oauth" ], "description": "Sign in with OAuth2", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_sign_in_oauth2_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_sign_in_oauth2_200_response" }, "400": { "$ref": "#/components/responses/post_sign_in_oauth2_400_response" }, "401": { "$ref": "#/components/responses/post_sign_in_oauth2_401_response" }, "403": { "$ref": "#/components/responses/post_sign_in_oauth2_403_response" }, "404": { "$ref": "#/components/responses/post_sign_in_oauth2_404_response" }, "429": { "$ref": "#/components/responses/post_sign_in_oauth2_429_response" }, "500": { "$ref": "#/components/responses/post_sign_in_oauth2_500_response" } } } }, "/oauth2/callback/{providerId}": { "get": { "tags": [ "Generic-oauth" ], "description": "OAuth2 callback", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/code_query_spec_paths_oauth2_callback_providerId_get_parameters_0" }, { "$ref": "#/components/parameters/error_query_spec_paths_oauth2_callback_providerId_get_parameters_1" }, { "$ref": "#/components/parameters/error_description_query_spec_paths_oauth2_callback_providerId_get_parameters_2" }, { "$ref": "#/components/parameters/state_query_spec_paths_oauth2_callback_providerId_get_parameters_3" }, { "$ref": "#/components/parameters/iss_query_spec_paths_oauth2_callback_providerId_get_parameters_4" } ], "responses": { "200": { "$ref": "#/components/responses/get_oauth2_callback_providerId_200_response" }, "400": { "$ref": "#/components/responses/get_oauth2_callback_providerId_400_response" }, "401": { "$ref": "#/components/responses/get_oauth2_callback_providerId_401_response" }, "403": { "$ref": "#/components/responses/get_oauth2_callback_providerId_403_response" }, "404": { "$ref": "#/components/responses/get_oauth2_callback_providerId_404_response" }, "429": { "$ref": "#/components/responses/get_oauth2_callback_providerId_429_response" }, "500": { "$ref": "#/components/responses/get_oauth2_callback_providerId_500_response" } } } }, "/oauth2/link": { "post": { "tags": [ "Generic-oauth" ], "description": "Link an OAuth2 account to the current user session", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_oauth2_link_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_oauth2_link_200_response" }, "400": { "$ref": "#/components/responses/post_oauth2_link_400_response" }, "401": { "$ref": "#/components/responses/post_oauth2_link_401_response" }, "403": { "$ref": "#/components/responses/post_oauth2_link_403_response" }, "404": { "$ref": "#/components/responses/post_oauth2_link_404_response" }, "429": { "$ref": "#/components/responses/post_oauth2_link_429_response" }, "500": { "$ref": "#/components/responses/post_oauth2_link_500_response" } } } }, "/api-key/create": { "post": { "tags": [ "Api-key" ], "description": "Create a new API key for a user", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_api_key_create_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_api_key_create_200_response" }, "400": { "$ref": "#/components/responses/post_api_key_create_400_response" }, "401": { "$ref": "#/components/responses/post_api_key_create_401_response" }, "403": { "$ref": "#/components/responses/post_api_key_create_403_response" }, "404": { "$ref": "#/components/responses/post_api_key_create_404_response" }, "429": { "$ref": "#/components/responses/post_api_key_create_429_response" }, "500": { "$ref": "#/components/responses/post_api_key_create_500_response" } } } }, "/api-key/get": { "get": { "tags": [ "Api-key" ], "description": "Retrieve an existing API key by ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/configId_query_spec_paths_api_key_get_get_parameters_0" }, { "$ref": "#/components/parameters/id_query_spec_paths_api_key_get_get_parameters_1" } ], "responses": { "200": { "$ref": "#/components/responses/get_api_key_get_200_response" }, "400": { "$ref": "#/components/responses/get_api_key_get_400_response" }, "401": { "$ref": "#/components/responses/get_api_key_get_401_response" }, "403": { "$ref": "#/components/responses/get_api_key_get_403_response" }, "404": { "$ref": "#/components/responses/get_api_key_get_404_response" }, "429": { "$ref": "#/components/responses/get_api_key_get_429_response" }, "500": { "$ref": "#/components/responses/get_api_key_get_500_response" } } } }, "/api-key/update": { "post": { "tags": [ "Api-key" ], "description": "Update an existing API key by ID", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_api_key_update_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_api_key_update_200_response" }, "400": { "$ref": "#/components/responses/post_api_key_update_400_response" }, "401": { "$ref": "#/components/responses/post_api_key_update_401_response" }, "403": { "$ref": "#/components/responses/post_api_key_update_403_response" }, "404": { "$ref": "#/components/responses/post_api_key_update_404_response" }, "429": { "$ref": "#/components/responses/post_api_key_update_429_response" }, "500": { "$ref": "#/components/responses/post_api_key_update_500_response" } } } }, "/api-key/delete": { "post": { "tags": [ "Api-key" ], "description": "Delete an existing API key", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/post_api_key_delete_request_body" }, "responses": { "200": { "$ref": "#/components/responses/post_api_key_delete_200_response" }, "400": { "$ref": "#/components/responses/post_api_key_delete_400_response" }, "401": { "$ref": "#/components/responses/post_api_key_delete_401_response" }, "403": { "$ref": "#/components/responses/post_api_key_delete_403_response" }, "404": { "$ref": "#/components/responses/post_api_key_delete_404_response" }, "429": { "$ref": "#/components/responses/post_api_key_delete_429_response" }, "500": { "$ref": "#/components/responses/post_api_key_delete_500_response" } } } }, "/api-key/list": { "get": { "tags": [ "Api-key" ], "description": "List all API keys for the authenticated user or for a specific organization", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "$ref": "#/components/responses/get_api_key_list_200_response" }, "400": { "$ref": "#/components/responses/get_api_key_list_400_response" }, "401": { "$ref": "#/components/responses/get_api_key_list_401_response" }, "403": { "$ref": "#/components/responses/get_api_key_list_403_response" }, "404": { "$ref": "#/components/responses/get_api_key_list_404_response" }, "429": { "$ref": "#/components/responses/get_api_key_list_429_response" }, "500": { "$ref": "#/components/responses/get_api_key_list_500_response" } } } } }, "tags": [ { "name": "Default", "description": "Default endpoints that are included with Better Auth by default. These endpoints are not part of any plugin." } ] }