# Userverse

## Docs

- [Companies](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/companies/companies.md): Create, retrieve, and update companies in Userverse.
- [Members](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/companies/members.md): List, add, and remove users from a company.
- [Roles](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/companies/roles.md): Create, update, delete, and list roles within a company.
- [Authentication](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/users/auth.md): Endpoints for user login and account creation using Basic Auth.
- [Password reset](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/users/password.md): Endpoints for requesting a password reset and validating the OTP to set a new password.
- [Profile](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/users/profile.md): Endpoints for retrieving and updating the authenticated user profile, and listing associated companies.
- [Verification](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/users/verification.md): Endpoints for verifying a user account and resending verification emails.
- [Basic Auth](https://mintlify.wiki/SoftwareVerse/userverse/authentication/basic-auth.md): Use HTTP Basic Auth to register, log in, and reset your password. Userverse validates your credentials and returns a JWT token pair.
- [JWT authentication](https://mintlify.wiki/SoftwareVerse/userverse/authentication/jwt.md): Pass a Bearer token in the Authorization header to authenticate requests to protected endpoints.
- [Authentication overview](https://mintlify.wiki/SoftwareVerse/userverse/authentication/overview.md): Userverse uses two authentication methods: HTTP Basic Auth to obtain tokens, and JWT Bearer tokens for all protected endpoints.
- [Configuration](https://mintlify.wiki/SoftwareVerse/userverse/configuration.md): Configure Userverse using a JSON file. This page describes every available option and how the config loader resolves settings.
- [Database setup](https://mintlify.wiki/SoftwareVerse/userverse/deployment/database.md): Configure a PostgreSQL database for Userverse and apply schema migrations with Alembic.
- [Docker deployment](https://mintlify.wiki/SoftwareVerse/userverse/deployment/docker.md): Build and run Userverse as a Docker container. This page covers the Dockerfile, required environment variables, and a complete docker run example.
- [Observability](https://mintlify.wiki/SoftwareVerse/userverse/deployment/observability.md): Monitor Userverse with Prometheus metrics, OpenTelemetry tracing, and structured request logging.
- [Company management](https://mintlify.wiki/SoftwareVerse/userverse/guides/company-management.md): Create a company, look it up, update its details, and manage the users who belong to it.
- [Email verification](https://mintlify.wiki/SoftwareVerse/userverse/guides/email-verification.md): Understand how Userverse verifies user email addresses after registration and how to resend the verification email when needed.
- [Password reset](https://mintlify.wiki/SoftwareVerse/userverse/guides/password-reset.md): Reset a forgotten password using a one-time PIN (OTP) sent to the user's email address.
- [Roles and permissions](https://mintlify.wiki/SoftwareVerse/userverse/guides/roles-and-permissions.md): Understand the default roles Userverse creates automatically, and learn how to create, update, list, and delete custom roles for a company.
- [User management](https://mintlify.wiki/SoftwareVerse/userverse/guides/user-management.md): Register a user, verify their account, log in, update profile details, and list associated companies.
- [Introduction](https://mintlify.wiki/SoftwareVerse/userverse/introduction.md): Userverse is an open-source FastAPI platform for managing users, organizations, roles, and authentication.
- [Quickstart](https://mintlify.wiki/SoftwareVerse/userverse/quickstart.md): Get Userverse running locally and make your first authenticated API request.

## OpenAPI Specs

- [openapi](https://mintlify.wiki/SoftwareVerse/userverse/api-reference/openapi.json)