Manage Access Keys

Create Access Keys for Services

You can give users access to a specific service using access keys. You do this by creating a new role with only the service's permissions enabled and assigning it to an employee profile with no features enabled. You then generate the access key on the employee profile and share it with users you want to access the service.

1. Add a new role with custom permissions required for the service.

   1. Click the app selector and select Admin.
   2. Go to Security > Roles and Permissions.

   3. Click New Role.

   4. Give the role a descriptive name. For the use case described previously, you might call it ScreenAgent Access Key.

   5. Select only the permissions required for the service. Selecting other permissions will grant users extra administrative privileges in addition to those required to use the service.

   6. Click Save & Activate.

2. Create a new employee profile for your service:

   1. Click the app selector and select Admin.

   2. Click Employees.

   3. Click New Employee.

   4. Give the employee profile an email address you own so that you can activate the employee account later.

   5. Give the employee profile a descriptive first and last name. For the use case described previously, you might call it ScreenAgent AccessKey.

   6. In the Primary Role drop-down, assign the employee to the role you just created.

   7. On the General tab, clear the checkboxes for all attributes so you aren't charged for the account.

   8. Click Create.

3. In the Employees table, click the new employee profile you created to open it.

4. Click the Access Keys tab.

5. Click Generate New Access Key.

6. Copy the Access Key ID and paste it somewhere you can save it.

7. Click (SHOW SECRET KEY).

8. Copy the Secret Access Key and paste it where you want to save it. If you ever lose the secret key, you'll need to create and share a new one.

9. Click Save.

10. In the Employees table, click Invite next to the new employee profile you created.

11. When you receive the account activation email, follow the instructions in the email to activate the account.

12. Share the access key only with users you want to use the service.

Use of Access Keys through Global Authentication/Token Endpoint

You can authenticate your users with access keys through the CXone global authentication/token endpoint. To do so, you have to register for this method in the DEVone Developer Community . CXone supports a single API endpoint to retrieve access tokens. You can discover the endpoint for access keys with OpenID Connect discovery.

Delete Access Keys with Access Key Manager

The Access Key Manager page allows you to view all the access keys in your system. It displays:

• The Access Key ID.

• When the key was created and last used.

• The owner of the key.

• Whether the key is active or inactive.

You can activate, deactivate, or delete access keys from this page.

1. Click the app selector and select Admin.

2. Go to Security Settings > Access Key Manager.

3. Locate the access key you want to delete.
4. Click Delete .

5. If you want to delete all of the access keys in your system, click Delete all access keys, then click Delete.

   This action is irreversible and may result in loss of access to your system.