get.json 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. {
  2. "operationId": "getUser2faStatus",
  3. "summary": "Get user 2fa Status",
  4. "tags": ["users"],
  5. "security": [
  6. {
  7. "bearerAuth": []
  8. }
  9. ],
  10. "parameters": [
  11. {
  12. "in": "path",
  13. "name": "userID",
  14. "schema": {
  15. "type": "integer",
  16. "minimum": 1
  17. },
  18. "required": true,
  19. "description": "User ID",
  20. "example": 2
  21. }
  22. ],
  23. "responses": {
  24. "200": {
  25. "description": "200 response",
  26. "content": {
  27. "application/json": {
  28. "examples": {
  29. "default": {
  30. "value": {
  31. "enabled": false,
  32. "backup_codes_remaining": 0
  33. }
  34. }
  35. },
  36. "schema": {
  37. "type": "object",
  38. "additionalProperties": false,
  39. "required": ["enabled", "backup_codes_remaining"],
  40. "properties": {
  41. "enabled": {
  42. "type": "boolean",
  43. "description": "Is 2FA enabled for this user",
  44. "example": true
  45. },
  46. "backup_codes_remaining": {
  47. "type": "integer",
  48. "description": "Number of remaining backup codes for this user",
  49. "example": 5
  50. }
  51. }
  52. }
  53. }
  54. }
  55. }
  56. }
  57. }