Documentation

Create API Keys

API Keys are required to publish your KAB files to KOS Studio and guarantee that the person publishing to your Artifact inventory has the appropriate permissions to do so. Learn more about publishing a KAB here.

Create API keys is only available for KOS studio admin user.

Access create API keys

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

View existing API keys

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

  3. Create API Keys opens in a new window where all active API Keys for your organization are available. Consider following :

    1. If no active API keys are present, the system displays no keys are present and asks the user to create a new one.

    2. Each key displays and provides the name, last connected date, and created date.

Create an API key

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

  3. This opens a Create New API Key pop-up, provide a unique name for the key, and click on “Create”.

  4. API key is now created and is displayed on the pop-up to be copied. Click on the copy copy to copy the API key.

  5. Click OK to close the pop-up.

  6. This creates provided API key, which is now displayed in a list of API keys.

  7. Consider following:

    1. API key value is only displayed to copy at the time of creation and can not be accessed once the pop-up is closed.

Suspend an API key

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

  3. Create API Keys opens in a new window displaying all active API Keys for your organization.

  4. Select the more icon more for the API key you wish to suspend and select Suspend.

  5. Consider following:

    1. Publishing artifacts with the suspended API key is blocked.

Restore an API key

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

  3. Create API Keys opens in a new window displaying all active API Keys for your organization.

  4. Select the more icon more for the already suspended API key you wish to restore and select Restore.

  5. Consider following:

    1. Publishing artifacts with the restored API key will be allowed after restoring the API key

Delete an API key

  1. Log in to KOS Studio.

  2. Select Settings main settings from top navigation (in the upper right corner of the screen) > Create API Keys

  3. Create API Keys opens in a new window displaying all active API Keys for your organization.

  4. Select the more icon more for the API key you wish to delete and select Delete. Confirm on the confirmation pop-up.

Consider following:
  • Publishing with the deleted API key is not allowed.

  • The deletion of the API keys can not be reversed.

Previous
Next
On this page
Related Articles
Expand your knowledge with these curated articles that complement your exploration of KOS.
publishtool
How to use commandline publishtool
Everything is a KAB
Learn more about KAB files
Java Development
Seamlessly transition from Legacy+ systems to Freestyle microdosing and advanced distributed dispense systems.
UI Development
Using KOS SDKs, integrating Consumer and Non-consumer facing UIs becomes seamless, giving you less hassle and more time to create.
Video Library
Meet some of our development team, as they lead you through the tools, features, and tips and tricks of various KOS tools.
Resources
Familiarize yourself with KOS terminology, our reference materials, and explore additional resources that complement your KOS journey.
Copyright © 2024 TCCC. All rights reserved.