Skip to content

Server API Summary ​

Below is a summarized table of the key endpoints available. For detailed, interactive documentation and to try the API live, visit: http://localhost:3002/docs/api when you're running the AuthC Server.


Endpoint Summary Table ​

PathMethodSummaryTagAuth Required?
/v1/admin/usersPOSTCreate User AccountsAdmin APIYes (Admin JWT)
/v1/admin/usersGETList User AccountsAdmin APIYes (Admin JWT)
/v1/admin/users/{uuid}PATCHUpdate User AccountAdmin APIYes (Admin JWT)
/v1/admin/users/{uuid}DELETEDelete User AccountAdmin APIYes (Admin JWT)
/v1/admin/loginPOSTAdmin Login (get token)Admin APINo
/v1/admin/token/refreshPOST/DELETERefresh Admin Access TokenAdmin APINo (uses refresh token)
/v1/admin/logout/{uuid}DELETEAdmin LogoutAdmin APIYes (Admin JWT)
/v1/auth/registerPOSTRegister User AccountAuth APINo
/v1/auth/loginPOSTUser LoginAuth APINo
/v1/auth/profilePOSTUpdate User ProfileAuth APIYes (User JWT)
/v1/auth/recoveryPOSTAccount Recovery (send email)Auth APINo
/v1/auth/refreshPOST/DELETERefresh User Access TokenAuth APINo (uses refresh token)
/v1/auth/registration-optionsPOSTWebAuthn Registration OptionsWebAuthn APINo
/v1/auth/registration-verificationPOSTComplete WebAuthn RegistrationWebAuthn APINo
/v1/auth/login-optionsGETWebAuthn Auth OptionsWebAuthn APINo
/v1/auth/login-verificationPOSTComplete WebAuthn LoginWebAuthn APINo
/healthGETServer Health CheckHealth ChecksNo

How to Explore Further ​

  • Try the API: Open http://localhost:3002/docs/api in your browser while the server is running.
  • Interactive Documentation: The documentation UI allows you to try endpoints, inspect request/response schemas, and view detailed requirements.
  • Authentication: Most Admin endpoints require a Bearer JWT token; obtain one via the /v1/admin/login endpoint.
  • WebAuthn: For passwordless flows, use endpoints under the WebAuthn API tag.

OAS Screenshot ​

For full request/response details, parameter descriptions, and advanced features, please consult the live documentation at http://localhost:3002/docs/api