Skip to content

User Management API

M♢NTΛSIM edited this page Aug 17, 2024 · 1 revision

User Management API Documentation

Fetch User Activity Information

  • GET /activity
    • Summary: Retrieves activity-related information for a user. Only authorized users can access this endpoint.
    • Security: Bearer Authentication
    • Responses:
      • 200 OK:
        • Description: User activity information retrieved successfully.
        • Content:
          • Content-Type: application/json
          • Schema:
            {
              "type": "object",
              "properties": {
                "userId": {
                  "type": "string",
                  "description": "Unique identifier of the user."
                },
                "lastLogin": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Last login time of the user."
                },
                "lastActivity": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Last activity time of the user."
                }
              }
            }
      • 401 Unauthorized: Unauthorized access.
      • 404 Not Found: User not found.
    • Tags:
      • User Management

Handles Unsupported Methods for User Activity Route

  • All Other Methods on /activity
    • Summary: Handles unsupported methods for the user activity route.
    • Responses:
      • 405 Method Not Allowed: Method not supported.
    • Tags:
      • User Management

Fetch User Security Settings

  • GET /security
    • Summary: Retrieves security-related settings for a user. Accessible only to authenticated users.
    • Security: Bearer Authentication
    • Responses:
      • 200 OK:
        • Description: User security settings retrieved successfully.
        • Content:
          • Content-Type: application/json
          • Schema:
            {
              "type": "object",
              "properties": {
                "userId": {
                  "type": "string",
                  "description": "Unique identifier of the user."
                },
                "twoFactorEnabled": {
                  "type": "boolean",
                  "description": "Indicates if two-factor authentication is enabled."
                }
              }
            }
      • 401 Unauthorized: Unauthorized access.
      • 404 Not Found: User not found.
    • Tags:
      • User Management

Handles Unsupported Methods for User Security Route

  • All Other Methods on /security
    • Summary: Handles unsupported methods for the user security route.
    • Responses:
      • 405 Method Not Allowed: Method not supported.
    • Tags:
      • User Management