Create an API-only user
Create an N-central user with API-only access permissions.
To programmatically access N-able N-central APIs, use a dedicated API-only user. This user will have access to the public APIs but not the user interface. If you attempt to log in to the N-central interface as an API-only user, you will receive the message: “This user account does not have access to the UI.”
In line with security best practices, we recommend assigning the least amount of privilege (roles and permissions) to the account used for API calls. The API-only user follows the same rules as the end user, including a Role and Access Group. To find the minimum roles and permissions for a specific API endpoint, use an existing role with the least privilege that can perform the same action through the UI. For further information on role permissions, review the N-central Permissions Dictionary & Menus.
Create the API-only user
- Go to Administration > User Management > Users.
- Click Create User and enter the new user information and password.
- Assign roles and access groups. A user can have more than one role or access group :
- Click the Role tab, then Assign Roles. Select one or more roles and click Assign.
- Click the Access Groups tab, then Assign Access Groups. Select one or more access groups and click Assign.
- Disable two-factor authentication:
- Click the User Details tab, then the User Information tab.
- Under Access, clear the checkbox next to Use Two-Factor Authentication. You need to disable two-factor authentication to pass along the JSON Web Token.
- Click Save.
- Configure API access:
- Select the login name of the user you just created to open the Modify User dialog.
- Click the API Access tab and select the API-Only User checkbox.
- To authenticate the API user with a web token click Generate JSON Web Token and copy the token for login use. For more information, see Generate a JSON web token.
- Click OK then Save.
The new user appears on the Users list. You can identify the API user in the user list in the API-Only User column. If you assigned a Role and an Access Group, a triangle appears next to the user name.
Create an API-only User Video
Updated about 2 months ago