Add an API key or view API key details (Administrators)
The API key administrator can manage the keys that are associated with all NetBackup users.
Only one API key can be associated with a specific user at a time. If a user requires a new API key, the user or administrator must delete the key for that user. An expired API key can be reissued. The 'View' RBAC permission is required to create an API key.
To add an API key
- On the left, select Security > Access keys > API keys.
- On left, click Add.
- Enter a Username for which you want to create the API key.
- (Conditional) If the API key is for a SAML user, select SAML authentication.
A new API key for a SAML user remains inactive until the user signs into the web UI.
- Indicate how long you want the API key to be valid, from today's date.
NetBackup calculates the expiration date and displays it.
- Click Add.
- To copy the API key, click Copy and close.
Store this key in a safe place. After you click Copy and close, the key cannot be retrieved again. If this API key replaces a previous key for your account, you must update any scripts, etc. to reflect the new API key.
An API key administrator can view the API key details that are associated with all NetBackup users.
To view API key details
- On the left, select Security > Access keys > API keys.
- Locate the API key that you want to view.
- Click Actions > Edit to edit the date or description for the key.