API Keys are valid for one year from the date of creation. During this time, the API Key can be disabled, activated, deleted, regenerated, or renewed using the Actions options (see Figure 7 API Access Key information with Actions options).
To view the API Key status
- By default, the API Key status will be Active with the slider on the right side (On).
To disable the API Key
- By toggling the slider to the left (Off), the API Key will be disabled.
- A pop-up message will be displayed, requesting the user to confirm disabling of the API Key (see Figure 8 Disable API Key confirmation pop-up).
- By selecting the “Disable” button, the status will be updated as Disabled (see Figure 9 API Key with disabled status).
- By selecting the “Cancel” button, the pop-up will be closed.
To activate the API Key
- The user can activate a disabled API Key with the Disable / Activate slider. The user can toggle the slider to the right (On),
- A pop-up message will be displayed, requesting the user to confirm the API Key activate (see Figure 10 Activate API Key confirmation pop-up).
- By selecting the “Activate” button, the status will be updated as Active.
- Once the API Key has been activated, the user can perform normal functions unless MFA has been disabled for any reason on the user’s account (see Figure 11 API Key activated after disabling).
- By selecting the “Cancel” button, the pop-up will be closed.
To regenerate the API Key
- An API Key can be regenerated to eliminate the old one and create a new API Key and Access Secret.
- By selecting the “Regenerate” icon, the API Key will be regenerated.
- A pop-up message will be displayed, requesting the user to confirm the API Key regeneration (see Figure 12 Regenerate new API Key confirmation pop-up).
- By selecting the “Get New Key” button, a new Access Key and Access Secret Key are generated (see Figure 13 New API Key regenerated).
- By selecting the “Cancel” button, the pop-up will be closed.
To delete the API Key
- By selecting the “Delete” icon, the API Key will be deleted at any time.
- A pop-up message will be displayed, requesting the user to confirm the API Key deletion (see Figure 14 Delete API Key confirmation pop-up).
- By selecting the “Delete” button, the API Key will be deleted.
- After an API Key has been deleted, the URC page will be reset to show the “Generate New Key” button (see Figure 15 API Key information deleted).
- By selecting the “Cancel” button, the pop-up will be closed.
Figure 8 Disable API Key confirmation pop-up
Figure 9 API Key with disabled status
Figure 10 Activate API Key confirmation pop-up
Figure 11 API Key activated after disabling
Figure 12 Regenerate new API Key confirmation pop-up
Figure 13 New API Key regenerated
Figure 14 Delete API Key confirmation pop-up
Figure 15 API Key information deleted