Skip to content

User Management

Alexandar83 edited this page Feb 25, 2025 · 15 revisions

This page outlines the user account management basics in The Wall API.

1. User Management

  • Users can create an account by providing their details (username, password, email(optional)) to the Create User endpoint.

  • Authentication is required to access the API endpoints:

    • Use the Login endpoint to obtain a new token, or retrieve an already existing one.
      Newly created tokens are valid until they are explicitly revoked.
  • Tokens must be included in the Authorization header as Token <your_token> in all subsequent requests.

  • Users can update their password using the Set Password endpoint.

  • Users can revoke their tokens via the Logout endpoint.

  • Users can delete their account using the Delete User endpoint.

2. Config ID Query Parameter

  • A valid config_id for an uploaded wall configuration must be provided for each request to the 'profiles' endpoints.

  • A config_id serves as a reference to a specific build simulation.
    This allows for several users to have references to the same simulation, avoiding unnecessary data duplication.

💡 Please refer to the Detailed OpenAPI Documentation for more details and example use cases.


Next: General Workflow and Swagger UI Guide

DFS Index
Home Page


Clone this wiki locally