System > API Keys

Create a new API Key

Create the API Keys used for API access.

Two Line OfieREQUIRED: The API Module must be enabled for your organization to perform the functions on this support page. Reach out to your Customer Success Manager to enable it.

Who can create a new API Key?

Only people with the "API Administrator" permission can create new API Keys.

Create a new API Key

To create a new API Key, navigate to the API Keys administration page, then:

  • Click Create API Key at the top of the list of API Keys and the New API Key window will open.

The API Keys admin page with an arrow pointing to the Create API Key button

    • Name (required): The name will be used to identify this API Key.
    • Determine the API Key's level of access within KaiNexus — the people and Items with which it has permission to work — by configuring its Locations and Roles:
      • Network Locations (required): Use this field to search for and select the appropriate Network Location(s).
      • Roles: The API Key's Roles determine its powers and permissions within KaiNexus. For example, an API Key with the "View Private" permission for a specific Location can be used to export an Item List containing private Items in that Location.
        • To add a Role, click the plus icon in the top-right corner of the Roles section and, in the resulting drop-down menu, check the checkbox next to each Role you want to add.
        • To remove a Role, click the x button to the right of that Role.
      • If the API Key has two or more Network Locations and one or more Roles, you can determine which Roles should apply in which Locations. To do so, click the cogwheel icon in the top-right corner of the Roles section to open the Advanced Role Configuration window.
        • If the intersection of a Role and a Location has a checkmark, that Role's permissions will be applied in that Location; if the intersection is unchecked, that Role will not apply in that Location.

          Check and uncheck Role/Location intersections as necessary, then click Save.
    • Click Save.