Create an API Key

To create an API key:

  1. Login as an admin and select the appropriate org, if required.
  2. Click theicon in the top bar > Users in the People section.
  3. Click Create User.
  4. Enter the user's name in the First Name and Last Name field.
  5. Enter an email address in the Email field. If the API key is for a production environment, enter a valid company email address.
  6. From the Edit User page, click the icon next to All Access to allow the user to view, edit, and delete all data in the org. Alternatively, you may add the user to a role or user group.
  7. Optional: Click the icon next to Admin to enable administrative rights.
    For added security, it's recommended that the Admin setting is not enabled for API users unless admin privileges are needed to complete the required API calls.
  8. Click Create.
  9. From the Edit User page, record the account's internal ID from the address bar of your browser (e.g., 1732).
    The Edit User page. The user's internal ID is displayed in the address bar.
  10. Click theicon in the top bar > Swagger Docs in the Tools section.
  11. Enter the keyword user in the search text box, then click User from the results to open the Swagger interface in a new tab.
    The Swagger API Documentation page.
  12. Scroll down to view the user resource.
  13. Click GET /user/users/me (who am I?) to expand it.
    The GET /user/users/me endpoint.
  14. Click Try it out!
  15. Record or copy the id number from the currentOrg section to your clipboard. This is the current org's internal ID.
    The Response Body section of the GET /user/users/me endpoint.
  16. Scroll up and expand the org resource to display the available endpoints.
  17. Click GET /user/org/{orgId}/user/{userId} (load a user org membership) endpoint to expand it.
    The GET /user/org/{orgId}/user/{userId} endpoint.
  18. Enter the org number copied during step 15 in the orgId field.
  19. Enter the user ID, copied during step 9 from the Edit User page, in the userId field.
    The expanded GET /user/org/{orgId}/user{userId} endpoint.
  20. Click Try it out!
  21. From the Response Body, record or copy the id number to your clipboard. This is the user's org membership ID number.
    The Response Body section of the GET /user/org/{orgId}/user/{userId} endpoint.
  22. Scroll up and expand the apiKey resource to display the available endpoints.
  23. Click POST /user/apiKey (create an api key) endpoint to expand it.
    The POST /user/apiKey (create an api key) endpoint.
  24. In the Parameters section, click the Example Value box to populate the template in the body text box.
    The Example Value box.
  25. In the body text box, delete the 0 in the orgUserId attribute, then enter the user's org membership ID number, obtained in step 21. 
  26. Enter a descriptive name for the API key in the name attribute (e.g., Integration Account).A completed body text box.
    The canImpersonate attribute makes it possible to impersonate another user while using the API key; however, only members of Resolver Support can enable impersonation through the API. Otherwise, setting this attribute to true will result in an error. Contact Resolver Support should you wish to enable this feature. For more information on impersonating a user with an API key, see Impersonation with an API Key.
  27. Click Try it out!
  28. Copy the apiKey from the Response Body and store it for safekeeping. 
    The Response Body displaying the ID and API key.
    For security purposes, once an API key is generated, it cannot be retrieved. If you misplace an API key, a new key must be generated.