Set Up a User API Key

Client managers must generate an API key and secret value in order to authenticate in the token call. This key value is passed in the RESTful call.

The keys are stored at the client user level. If the client manager has more than one user account (for example, one account for BizOrg A, and one for BizOrg B), then they need to generate a key for each account, even if they have their user accounts linked.
Note: Only a client manager user can complete this task.

API keys are generated with an expiration date. This date cannot be removed. After expiration, a new key must be manually generated. A key can be inactivated at any time by clicking Inactivate. If a key is inactivated, a new key must be manually generated.

  1. Navigate to the Home page in the Manager view.
  2. Click User Account > User Profile.
  3. In the left menu, click RaaS API Keys.
    Note: The table is empty the first time that you generate a key. After you generate the first key, the key information is stored in the Your Credentials table. Inactive and expired key information appears in the Audit Log table.
    Note: You generate a new key at any time.
  4. Click .
    You can copy the value upon generation by clicking . Once you click , you must retrieve the value using the security code method (click View).