KIO Link
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
  1. Users
  • Auth
    • Overview
    • Log in
    • Send a one-time sign-in token
    • Log in with Apple
    • Validate a session token
    • Sign in with a one-time sign-in token
    • Request a password reset
    • Get the user of a password reset token
    • Reset a password
    • Submit a business registration request
    • Enable two-factor authentication
    • Confirm a two-factor login
  • Application Content
    • List application content
    • Create application content
    • Get application content by slug
    • Get application content by public id
    • Partially update application content
    • Delete application content
  • Businesses
    • Overview
    • Business Users
      • Overview
      • List business users by business
      • List a business's users
      • Create a business user
      • Get a business user
      • Update a business user
      • Upload a business user's avatar
      • Delete a business user's avatar
      • Deactivate business users
      • Search business users
      • Search a business's users
      • Send a password reset email to a business user
      • Reset a business user's daily sign-in code limits
      • Toggle a business user's two-factor authentication
      • Import business users from CSV
      • Export all business users
      • Set whether I receive releases
      • Set whether I receive alerts
      • Request the deletion of my account
    • Business Roles
      • Overview
      • List business user roles
      • Create a business user role
      • Get a business user role
      • Update a business user role
      • Delete a business user role
    • Business Permissions
      • Overview
      • List business user permissions
      • Create a business user permission
      • Delete a business user permission
    • Business Consoles
      • Overview
      • List a business's consoles
      • Create a business console
      • Delete a business console
    • Business Devices
      • Overview
      • List a business's devices
      • Search a business's devices
      • Export all business devices
      • Export my business's devices
      • Import business devices from CSV
      • Start device transfers from CSV
      • Import device statuses from CSV
      • Delete business devices
      • Change a device's owner
      • Get a business's device transfer log
    • Business Racks
      • Overview
      • Export all business racks
      • Assign a rack to a business
      • List a business's racks
      • List all business racks
      • Change a business rack's status
      • Delete business racks
      • Restore a deleted business rack
      • Import business racks from CSV
    • Business Locations
      • Overview
      • Update a business's status and datacenters
      • Migrate business locations to datacenters
      • Remove the old locations field from businesses
      • Migrate business user locations to datacenters
      • Migrate business device locations to datacenter names
    • Business Reports
      • Overview
      • Send the visits reports
      • Download a visits report
      • Set a business's report recipients
    • List businesses
    • Search businesses
    • Search businesses by name or extra data
    • Export businesses
    • Get a business
    • Create a business
    • Import businesses from CSV
    • Update a business
    • Delete a business
  • Banned Devices
    • List banned devices
    • Check if a device is risky or banned
    • Get a banned device
    • Create a banned device
    • Update a banned device
    • Delete a banned device
  • Data Centers
    • Listar data centers
    • Crear un data center
    • Actualizar un data center
    • Eliminar un data center
  • Intake Forms
    • List intake form reponses
    • Get an intake form's response
    • Get an intake form's response license file
    • Get an intake form's response identification file
    • Download intake form responses report
    • Create an intake form's response
    • Upload a license file to an intake form's response
    • Upload an identification file to an intake form's response
    • Update an intake form's response
    • Delete an intake form's response
  • Users
    • Overview
    • Permissions
      • Overview
      • Generate KIO user permissions
      • Generate business user permissions
      • List KIO user permissions
      • Create a KIO user permission
      • Delete a KIO user permission
    • Roles
      • Overview
      • List KIO user roles
      • Create a KIO user role
      • Get a KIO user role
      • Update a KIO user role
      • Delete a KIO user role
    • User Groups
      • Overview
      • List user groups
      • Create a user group
      • Update a user group
      • Delete a user group
    • List KIO users
      GET
    • Create a KIO user
      POST
    • Get a KIO user
      GET
    • Update a KIO user
      PATCH
    • Activate or deactivate a KIO user
      PATCH
    • Delete a KIO user
      DELETE
    • Generate a session token for a user
      GET
    • Export KIO users
      GET
    • Search active KIO users by name
      GET
    • Search KIO users
      GET
    • Look up an employee in SuccessFactors
      GET
    • Import KIO user updates from CSV
      PATCH
  • External Users
    • Overview
    • List external users
    • Find external users to invite
    • Search external users
    • Export external users
    • Create an external user
    • Edit an external user
    • Update an external user
    • Upload an external user's avatar
    • Delete an external user's avatar
    • Delete an external user
  • Send App Notification
    POST
  • Events Locations
    GET
  • Fetch Wires
    GET
  • Create Business Temporary Secret
    POST
  • Schemas
    • Auth
      • Auth Session
      • Two-Factor Status
      • Two-Factor Challenge
      • KIO User Session
    • Businesses
      • Business Users
        • Business User Role
        • Datacenter Access
        • Business User
        • Business User With Relations
        • Business User Permission
      • Business Devices
        • Business Device
        • Business Device Log Entry
      • Business Racks
        • Business Rack
        • Datacenter Rack
      • Business
      • Datacenter Assignment
      • Business List Item
      • Business Console
    • Users
      • User Role
      • User
      • User Permission
      • User Group
      • Permission Catalog
      • SuccessFactors Employee
    • External Users
      • External User
    • ApplicationContentCreate
    • ApplicationContentUpdate
    • ApplicationContent
    • ApplicationContentListResponse
    • Banned Device
    • Error
    • LanguageEntry
    • Pagination
    • Intake Form
    • DataCenter
    • LocalizedContent
    • Delete Result
    • Import Row Error
    • Bulk Write Result
    • Message
    • Personal Device
  1. Users

Overview

Users#

Management of internal KIO users (employees): their accounts, roles, permissions and groups. Client-side business users are managed under My Business.

Concepts#

KIO user: an employee account. KIO users sign in with Google or Apple (see Auth). Only active users (status: true) can sign in.
Roles and permissions: every user has one role, and a role grants a set of permissions. Endpoints check permissions by slug (e.g. users-users-read); a role's permission slugs are returned in the permissions array of the sign-in response. New users get the Suscriptor role by default.
HR data (keywe): company, job title, business unit, division, department, location and modality, synced from SAP SuccessFactors through Boomi (isBoomiUser: true) or entered manually.
Email deliverability (verify_email): set by a Mailgun check when a user is created. Notification emails are only sent to deliverable addresses.
Audit trail: creating or deleting a user is recorded in the user report; creating, updating or deleting a role is recorded in the permissions log.
Deleting a user also cancels every KIO Link event of the user that has not started yet.

Subfolders#

Permissions: the permission catalog and the KIO user permissions.
Roles: KIO user roles.
User Groups: named groups of KIO users.

Endpoints#

List KIO users#

GET /v1/users
Users sorted by first name, with optional skip/limit paging.

Create a KIO user#

POST /v1/users
Creates an active user and notifies the admins.

Get a KIO user#

GET /v1/users/{id}
Returns a single user.

Update a KIO user#

PATCH /v1/users/{id}
Writes any user field.

Activate or deactivate a KIO user#

PATCH /v1/users/{id}/status
Activates or deactivates a user.

Delete a KIO user#

DELETE /v1/users/{id}
Deletes a user and cancels their upcoming events.

Search active KIO users by name#

GET /v1/users/search/{name}
Up to 10 active users whose name or email starts with the text.

Search KIO users#

GET /v1/users/list/search
Up to 100 users whose email, name or role contains the text.

Export KIO users#

GET /v1/users/list/export-file
Downloads every user as a CSV file.

Import KIO user updates from CSV#

PATCH /v1/users-import
Updates existing users from a CSV file.

Look up an employee in SuccessFactors#

GET /v1/users/success/search/{email}
Looks up an employee in SuccessFactors to prefill a new user.

Generate a session token for a user#

GET /v1/users/generate-token/{id}/{type}/{number}/{time}
Issues a session token for any user (admins only).

Source#

Router: routes/v1/users.js
Controllers: controllers/users.js
Models: models/user.js, models/user_role.js, models/user_report.js
Services: services/success-factors.js, services/mailing.js
Email template: new-kio-user
Modified at 2026-10-05 20:21:01
Previous
Delete an intake form's response
Next
Overview
Built with