Generating a New API Key in the Asset Manager GUI
API Key in GUI
The API Key available only in the Asset Manager API and CLI is now available from the GUI. A user with MANAGE_USERS permission can create an API key for him- or herself or can create one for another user. Each key is a long string of 127 characters.
To create a new API key . . .
- Browse to Settings > Users.
- Select a user.
- Click Edit.
- Click the API Key field to select Enable.
- Click OK on the confirmation that API Key has been enabled.
- Click the API Key field again to select Copy.
- Copy the key to your clipboard to paste it at login.
- Click Save.
The API Key is enabled. Input it into the Password field when you next log in to Asset Manager. -
A user may only have one key at a time. Any user can have a key, but it's not required. All keys are unique.
The API commands to manage keys are . . .
| Method | API Command |
|---|---|
| GET | GET /api/rest/management/user/{USERNAME}/apikey?create={true|false}
|
| SET | DELETE /api/rest/management/{USERNAME}/apikey
|
Substitute a valid user name for {USERNAME}
For the GET operation, create=true means to make a new key if one does not exist, and create=false means return null and do not create a new key, even if no key exists for that user.