This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Creating Users and API Keys
This guide provides step-by-step instructions for creating users and API keys for UniFi Protect and UniFi Access. These credentials are required for secure integration and automation.
UniFi Protect
Creating a User
Log in to your UniFi Protect web interface (usually https://:7443 or https:///protect/).
Go to Admin & Users.
Click Create New.
Enable Admin checkbox
Enable Restrict to local access only
Enter the required details (name, email, password, role).
Assign the appropriate permissions (Viewer, Operator, Admin, etc.).
Save the user.
Creating an API Key (only needed for certain integrations)
Log in as the user you want to generate an API key for.
Go to Settings > Control Plane > Integrations (location may vary by version).
Click Generate API Key.
Copy and securely store the API key. You will not be able to view it again.
Note: API keys are tied to the user’s permissions. Use a dedicated user for integrations if possible.
UniFi Access
Creating a User (Only needed when you have UniFi Access)
Creating an API Key
Log in as the user for whom you want to create an API key.
Go to Settings > General > API Token (location may vary).
Click Create New.
Copy and securely store the API key.
Note: API keys for UniFi Access may require specific permissions for device or event access. Always use least privilege.
Security Recommendations
Use dedicated users for API integrations.
Restrict permissions to only what is necessary.
Store API keys securely and rotate them regularly.
Remove unused users and keys.
Troubleshooting
If you cannot find the API key section, ensure your controller is updated to the latest version.
Some features may require admin privileges.
Refer to official UniFi documentation for version-specific details.