Managing User access keys (UAKs)
Create a key that you can use to authenticate API calls.
About this task
Until new users are assigned to teams, they are automatically assigned to the Default team in the Viewer and Participant roles. Users in these roles can view objects, such as releases and value streams, but they cannot create or edit them. Additionally, users in these roles can auto-generate user access tokens and access API endpoints with GET requests. Administrators grant users elevated permissions when they assign them to roles such as Lead Developer or Release Manager.
Procedure
- On the Settings page, click New User Access Key. , and then click
- Enter a name for the key, and then click Create.
- In the Access key created window, click Copy key to copy the key to the Clipboard.
-
Save the key to a secure location.
Note: It's important to save the key because it will not be accessible after you close the Access key created window.
What to do next
Integrations support the capability to auto-generate the required user access keys that is
implemented on a plug-in by plug-in basis.
Note: Plug-ins are not updated at the same time and you can refer to the plug-in documentation page for the latest updates. The update status of existing integrations only change when you edit the integration.
The auto-generated user access key process is detailed
in the following:- On the HCL™ Accelerate Home page, click .
- Click the Add integration button for the required plug-in integration to display the Add Integration modal window.
- The User Access Key field is displayed if the plug-in is not
updated.Note: The User Access Key field is not displayed if the plug-in is updated.
- Fill in the required fields for the plug-in.
- Click the Show Hidden Properties check box to display the auto-generated
properties for the integration.Note: In the HCL™ Accelerate User Access Key field, you can enter a user access key if you have one, but it is not required.
- Click the Add button.
- Click Name field with the format of
Integration Name - AutoGen.Note: Any existing plug-in integrations that are edited and saved automatically auto-generate user access keys in the aforementioned manner.
to locate the plug-in in the
You can review the issued user access keys on the User access key management page, . If you have administrator permissions, you can delete user access keys from that page.