@djangocfg/api 2.1.54 → 2.1.56

package/src/generated/cfg_totp/schema.json

@@ -0,0 +1,859 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Django CFG API",
+    "version": "1.0.0",
+    "description": "Complete API documentation for Django CFG Demo Project",
+    "x-django-metadata": {
+      "group": "cfg_totp",
+      "apps": [
+        "django_cfg_totp"
+      ],
+      "generator": "django-client",
+      "generator_version": "1.0.0"
+    }
+  },
+  "paths": {
+    "/cfg/totp/backup-codes/": {
+      "get": {
+        "operationId": "cfg_totp_backup_codes_retrieve",
+        "description": "Get backup codes status for user.",
+        "tags": [
+          "Backup Codes"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BackupCodesStatus"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/backup-codes/regenerate/": {
+      "post": {
+        "operationId": "cfg_totp_backup_codes_regenerate_create",
+        "description": "Regenerate backup codes.\n\nRequires TOTP code for verification.\nInvalidates all existing codes.",
+        "tags": [
+          "Backup Codes"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BackupCodesRegenerateRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/BackupCodesRegenerateRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/BackupCodesRegenerateRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BackupCodesRegenerateResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid code or 2FA not enabled"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/devices/": {
+      "get": {
+        "operationId": "cfg_totp_devices_list",
+        "description": "List all TOTP devices for user.",
+        "parameters": [
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "description": "A page number within the paginated result set.",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "page_size",
+            "required": false,
+            "in": "query",
+            "description": "Number of results to return per page.",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "tags": [
+          "2FA Management"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaginatedDeviceListList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/devices/{id}/": {
+      "delete": {
+        "operationId": "cfg_totp_devices_destroy",
+        "description": "Delete a TOTP device.\n\nRequires verification code if removing the last/primary device.",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "totp"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No response body"
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/disable/": {
+      "post": {
+        "operationId": "cfg_totp_disable_create",
+        "description": "Completely disable 2FA for account.\n\nRequires verification code.",
+        "tags": [
+          "2FA Management"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/DisableRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/DisableRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/DisableRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "2FA disabled successfully"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid code"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/setup/": {
+      "post": {
+        "operationId": "cfg_totp_setup_create",
+        "description": "Start 2FA setup process.\n\nCreates a new TOTP device and returns QR code for scanning.",
+        "tags": [
+          "2FA Setup"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SetupRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/SetupRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/SetupRequest"
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SetupResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "2FA already enabled or invalid request"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/setup/confirm/": {
+      "post": {
+        "operationId": "cfg_totp_setup_confirm_create",
+        "description": "Confirm 2FA setup with first valid code.\n\nActivates the device and generates backup codes.",
+        "tags": [
+          "2FA Setup"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ConfirmSetupRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/ConfirmSetupRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/ConfirmSetupRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConfirmSetupResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid code or setup expired"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/verify/": {
+      "post": {
+        "operationId": "cfg_totp_verify_create",
+        "description": "Verify TOTP code for 2FA session.\n\nCompletes authentication and returns JWT tokens on success.",
+        "tags": [
+          "2FA Verification"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          },
+          {}
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VerifyResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid code or session"
+                }
+              }
+            },
+            "description": ""
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Too many attempts"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/totp/verify/backup/": {
+      "post": {
+        "operationId": "cfg_totp_verify_backup_create",
+        "description": "Verify backup recovery code for 2FA session.\n\nAlternative verification method when TOTP device unavailable.",
+        "tags": [
+          "2FA Verification"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyBackupRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyBackupRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/VerifyBackupRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          },
+          {}
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VerifyResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid backup code or session"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "BackupCodesRegenerateRequest": {
+        "type": "object",
+        "description": "Serializer for regenerating backup codes.",
+        "properties": {
+          "code": {
+            "type": "string",
+            "minLength": 6,
+            "description": "TOTP code for verification",
+            "maxLength": 6
+          }
+        },
+        "required": [
+          "code"
+        ]
+      },
+      "BackupCodesRegenerateResponse": {
+        "type": "object",
+        "description": "Response serializer for backup codes regeneration.",
+        "properties": {
+          "backup_codes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of new backup codes (save these!)"
+          },
+          "warning": {
+            "type": "string",
+            "description": "Warning about previous codes being invalidated"
+          }
+        },
+        "required": [
+          "backup_codes",
+          "warning"
+        ]
+      },
+      "BackupCodesStatus": {
+        "type": "object",
+        "description": "Serializer for backup codes status.",
+        "properties": {
+          "remaining_count": {
+            "type": "integer",
+            "description": "Number of unused backup codes"
+          },
+          "total_generated": {
+            "type": "integer",
+            "description": "Total number of codes generated"
+          },
+          "warning": {
+            "type": "string",
+            "nullable": true,
+            "description": "Warning if running low on codes"
+          }
+        },
+        "required": [
+          "remaining_count",
+          "total_generated"
+        ]
+      },
+      "ConfirmSetupRequest": {
+        "type": "object",
+        "description": "Serializer for confirming 2FA setup with first code.",
+        "properties": {
+          "device_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Device ID from setup response"
+          },
+          "code": {
+            "type": "string",
+            "minLength": 6,
+            "description": "6-digit TOTP code from authenticator app",
+            "maxLength": 6
+          }
+        },
+        "required": [
+          "code",
+          "device_id"
+        ]
+      },
+      "ConfirmSetupResponse": {
+        "type": "object",
+        "description": "Response serializer for setup confirmation.",
+        "properties": {
+          "message": {
+            "type": "string"
+          },
+          "backup_codes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of backup recovery codes (save these!)"
+          },
+          "backup_codes_warning": {
+            "type": "string",
+            "description": "Warning message about backup codes"
+          }
+        },
+        "required": [
+          "backup_codes",
+          "backup_codes_warning",
+          "message"
+        ]
+      },
+      "DeviceList": {
+        "type": "object",
+        "description": "Serializer for listing TOTP devices.",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "readOnly": true
+          },
+          "name": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Device name for identification"
+          },
+          "is_primary": {
+            "type": "boolean",
+            "readOnly": true,
+            "description": "Primary device used for verification"
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "active",
+              "disabled"
+            ],
+            "type": "string",
+            "description": "* `pending` - Pending Confirmation\n* `active` - Active\n* `disabled` - Disabled",
+            "x-spec-enum-id": "c058383a5a3854d4",
+            "readOnly": true
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "confirmed_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "When device setup was confirmed"
+          },
+          "last_used_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Last successful verification"
+          }
+        },
+        "required": [
+          "confirmed_at",
+          "created_at",
+          "id",
+          "is_primary",
+          "last_used_at",
+          "name",
+          "status"
+        ]
+      },
+      "DisableRequest": {
+        "type": "object",
+        "description": "Serializer for completely disabling 2FA.",
+        "properties": {
+          "code": {
+            "type": "string",
+            "minLength": 6,
+            "description": "TOTP code for verification",
+            "maxLength": 6
+          }
+        },
+        "required": [
+          "code"
+        ]
+      },
+      "PaginatedDeviceListList": {
+        "type": "object",
+        "required": [
+          "count",
+          "page",
+          "pages",
+          "page_size",
+          "has_next",
+          "has_previous",
+          "results"
+        ],
+        "properties": {
+          "count": {
+            "type": "integer",
+            "description": "Total number of items across all pages",
+            "example": 150
+          },
+          "page": {
+            "type": "integer",
+            "description": "Current page number (1-based)",
+            "example": 2
+          },
+          "pages": {
+            "type": "integer",
+            "description": "Total number of pages",
+            "example": 15
+          },
+          "page_size": {
+            "type": "integer",
+            "description": "Number of items per page",
+            "example": 10
+          },
+          "has_next": {
+            "type": "boolean",
+            "description": "Whether there is a next page",
+            "example": true
+          },
+          "has_previous": {
+            "type": "boolean",
+            "description": "Whether there is a previous page",
+            "example": true
+          },
+          "next_page": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Next page number (null if no next page)",
+            "example": 3
+          },
+          "previous_page": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Previous page number (null if no previous page)",
+            "example": 1
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeviceList"
+            },
+            "description": "Array of items for current page"
+          }
+        }
+      },
+      "SetupRequest": {
+        "type": "object",
+        "description": "Serializer for starting 2FA setup.",
+        "properties": {
+          "device_name": {
+            "type": "string",
+            "minLength": 1,
+            "default": "Authenticator",
+            "description": "Device name for identification (e.g., 'My iPhone')",
+            "maxLength": 100
+          }
+        }
+      },
+      "SetupResponse": {
+        "type": "object",
+        "description": "Response serializer for setup initiation.",
+        "properties": {
+          "device_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Device ID to use for confirmation"
+          },
+          "secret": {
+            "type": "string",
+            "description": "Base32-encoded TOTP secret (for manual entry)"
+          },
+          "provisioning_uri": {
+            "type": "string",
+            "description": "otpauth:// URI for QR code generation"
+          },
+          "qr_code_base64": {
+            "type": "string",
+            "description": "Base64-encoded QR code image (data URI)"
+          },
+          "expires_in": {
+            "type": "integer",
+            "description": "Seconds until setup expires (typically 600 = 10 minutes)"
+          }
+        },
+        "required": [
+          "device_id",
+          "expires_in",
+          "provisioning_uri",
+          "qr_code_base64",
+          "secret"
+        ]
+      },
+      "VerifyBackupRequest": {
+        "type": "object",
+        "description": "Serializer for backup code verification during login.",
+        "properties": {
+          "session_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "2FA session ID from login response"
+          },
+          "backup_code": {
+            "type": "string",
+            "minLength": 8,
+            "description": "8-character backup recovery code",
+            "maxLength": 8
+          }
+        },
+        "required": [
+          "backup_code",
+          "session_id"
+        ]
+      },
+      "VerifyRequest": {
+        "type": "object",
+        "description": "Serializer for TOTP code verification during login.",
+        "properties": {
+          "session_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "2FA session ID from login response"
+          },
+          "code": {
+            "type": "string",
+            "minLength": 6,
+            "description": "6-digit TOTP code from authenticator app",
+            "maxLength": 6
+          }
+        },
+        "required": [
+          "code",
+          "session_id"
+        ]
+      },
+      "VerifyResponse": {
+        "type": "object",
+        "description": "Response serializer for successful 2FA verification.",
+        "properties": {
+          "message": {
+            "type": "string"
+          },
+          "access_token": {
+            "type": "string",
+            "description": "JWT access token"
+          },
+          "refresh_token": {
+            "type": "string",
+            "description": "JWT refresh token"
+          },
+          "user": {
+            "type": "object",
+            "additionalProperties": {},
+            "description": "User profile data"
+          },
+          "remaining_backup_codes": {
+            "type": "integer",
+            "description": "Number of remaining backup codes (if backup code was used)"
+          },
+          "warning": {
+            "type": "string",
+            "description": "Warning message (e.g., low backup codes)"
+          }
+        },
+        "required": [
+          "access_token",
+          "message",
+          "refresh_token",
+          "user"
+        ]
+      }
+    },
+    "securitySchemes": {
+      "jwtAuthWithLastLogin": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "http://localhost:8000"
+    }
+  ]
+}