Prerequisites
You must be logged in as a user with theusers.create permission (or the SuperAdmin or Admin role) to manage users. Regular users do not have access to the /users page or the users API.
Create a user via the admin console
Fill in the details
Provide the following information:
- Username — the login name for the new user
- Password — an initial password; the user or an admin can reset it later
- Role — select a role (see User roles below)
- Active — leave checked to activate the account immediately
Create a user via the API
Send a POST request to/api/v1/users:
201 Created with the new user record:
User roles
NekoHub has a role hierarchy. Higher roles include all capabilities of lower roles.| Role | Description |
|---|---|
SuperAdmin | Full system access. Created automatically from the bootstrap environment variables on first deployment. |
Admin | Can manage users, storage providers, AI providers, and all assets. |
| (other roles) | Roles with more limited access, configured by a SuperAdmin. |
The
SuperAdmin account is seeded from Auth__BootstrapSuperAdmin__Username and Auth__BootstrapSuperAdmin__Password during the first deployment. Only one SuperAdmin is created this way.Grant or update permissions
In addition to roles, individual permissions can be granted to a user. UsePATCH /api/v1/users/{id}/permissions:
Disable or enable a user
To deactivate a user without deleting their account, usePOST /api/v1/users/{id}/status:
- Disable
- Enable
Reset a password
Admins can reset any user’s password usingPOST /api/v1/users/{id}/reset-password:
204 No Content. The user’s next login must use the new password.
NekoHub does not support self-service password reset, email verification, or MFA. Password changes must be performed by an admin through this endpoint or the admin console.