Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kion Users API

Manage users within the Kion platform

Kion Users API is one of 25 APIs that Kion publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 16 JSON Schema definitions.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 16 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 3.10.0.

Requests are made against a single base URL, https://{kion-instance}/api/v3.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.10.0
Base URL
https://{kion-instance}/api/v3
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kion Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Kion App API Key. Generate in Kion under your user profile settings. Use in the Authorization header as: Bearer YOURAPIKEY

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 5

Manage users within the Kion platform

GET
/user
Kion List users
listUsers → 200401
POST
/user
Kion Create a user
createUser body → 201401
GET
/user/{id}
Kion Get a user
getUser 1 param → 200401404
PATCH
/user/{id}
Kion Update a user
updateUser 1 param body → 200401404
DELETE
/user/{id}
Kion Delete a user
deleteUser 1 param → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), UserCreate (6 properties), UserUpdate (4 properties). Each schema is shown below with its type and property counts.

UserUpdate
object
4 properties
User
object
8 properties
UserCreate
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kion-users-api-openapi.yml Raw ↑

Other APIs Kion publishes across the network.

Kion Accounts API
Kion App Configuration API
Kion Azure ARM Templates API
Kion Azure Policies API
Kion Azure Roles API
Kion Cloud Access Roles API
Kion Cloud Rules API
Kion CloudFormation Templates API
Kion Compliance Checks API
Kion Compliance Standards API
Kion Custom Variables API
Kion Enforcements API