Skip to main content

User Management

Yattee Server requires authentication for all API access. Users are managed through the Users tab in the admin panel.

User Management

Roles

There are two roles:

RoleAPI AccessAdmin Panel
AdminFull access to all API endpointsFull access -- can manage users, sites, credentials, and settings
Regular UserCan use video, search, channel, feed, and playlist endpointsNo access to admin endpoints or the admin panel

The first admin account is created during the Setup Wizard or via auto-provisioning environment variables. Additional users are created through the admin panel.

Authentication

Yattee Server uses HTTP Basic Authentication. Clients send the username and password with every API request as a standard Authorization: Basic <base64> header.

note

There are no sessions or tokens for API access. The Yattee iOS/macOS/tvOS client handles this automatically -- you just enter the server URL, username, and password in the app settings.

Creating a User

  1. Open the admin panel and navigate to the Users tab.
  2. Click Add User.
  3. Enter a username and password.
  4. Optionally toggle Admin to grant admin privileges.
  5. Click Save.

Constraints

  • Username: 3 to 50 characters.
  • Password: minimum 6 characters.
  • Passwords are hashed with bcrypt before being stored in the database. Plain-text passwords are never persisted.

Managing Existing Users

Changing a Password

Select a user and update their password. The new password must meet the minimum 6-character requirement. The change takes effect immediately -- the user will need to use the new password on their next API request.

Granting or Revoking Admin Privileges

Toggle the Admin flag on any user to promote or demote them.

Deleting a User

Click the delete action on the user you want to remove. The user will immediately lose access to all API endpoints.

Best Practices

  • Create individual accounts for each person or device that needs access, rather than sharing a single set of credentials. This makes it easier to revoke access later if needed.
  • Use strong passwords. While the minimum is 6 characters, longer passwords with a mix of letters, numbers, and symbols are recommended, especially if your server is exposed to the internet.
  • Limit admin accounts. Most users only need regular access. Reserve admin privileges for people who need to manage server configuration.
  • Put the server behind HTTPS. Because HTTP Basic Auth sends credentials with every request, always use a reverse proxy with TLS termination when exposing Yattee Server to the internet.