Create and manage an integration API client

An integration API client is a non-human account that lets a third-party system connect to Kio Cloud. Unlike a user, a client signs in with a client ID and secret rather than an email and password, and it is assigned API roles rather than human-user roles. Create a client when you need to connect an external system to your account.

Before you start

• Required role: User Management Administrator and API Integration. The Administrator role alone does not show the Integration API menu — assign the API Integration role in addition to Administrator. See Platform roles overview.
• Decide which API roles the integration needs. A client can be assigned API roles only, grouped by area such as Device management, Location & occupancy, Entity management, Edge Server, and Patient Management.

Create an integration API client

1. From the Kontakt.io Launchpad, open Users.
2. From the side menu, select Integration API.
3. Select Add Client.
4. Enter a Name (up to 30 characters).
5. (Optional) Enter a Description (up to 512 characters).
6. Select Add Client.

The client is created and appears in the integration clients list with a system-generated client ID.

Assign roles to a client

1. From the side menu, select Integration API.
2. Select the client you want to configure.
3. Go to the Roles for Client section.
4. For each API area, select the roles to assign.
5. Save your changes.

The client can now call the APIs that its assigned roles allow.

View or rotate the client secret

The secret pairs with the client ID to authenticate the integration. Rotate the secret if it may have been exposed or as part of routine security maintenance.

1. Open the client's details page.
2. Go to the section that shows the client Secret. Use the copy action to copy the current secret.
3. To replace the secret, select the rotate action and confirm when prompted.

A sample token request is shown on the client's details page to help your integration team get started.