KIO Link
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
  1. Business 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
        GET
      • List a business's users
        GET
      • Create a business user
        POST
      • Get a business user
        GET
      • Update a business user
        PATCH
      • Upload a business user's avatar
        PATCH
      • Delete a business user's avatar
        DELETE
      • Deactivate business users
        PATCH
      • Search business users
        GET
      • Search a business's users
        GET
      • Send a password reset email to a business user
        GET
      • Reset a business user's daily sign-in code limits
        GET
      • Toggle a business user's two-factor authentication
        GET
      • Import business users from CSV
        POST
      • Export all business users
        GET
      • Set whether I receive releases
        PATCH
      • Set whether I receive alerts
        PATCH
      • Request the deletion of my account
        DELETE
    • 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
      GET
    • Search businesses
      GET
    • Search businesses by name or extra data
      GET
    • Export businesses
      GET
    • Get a business
      GET
    • Create a business
      POST
    • Import businesses from CSV
      POST
    • Update a business
      PATCH
    • Delete a business
      DELETE
  • 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
    • Create a KIO user
    • Get a KIO user
    • Update a KIO user
    • Activate or deactivate a KIO user
    • Delete a KIO user
    • Generate a session token for a user
    • Export KIO users
    • Search active KIO users by name
    • Search KIO users
    • Look up an employee in SuccessFactors
    • Import KIO user updates from CSV
  • 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. Business Users

Overview

Business Users#

Users of client businesses: management by KIO admins, and settings of the signed-in business user.

Concepts#

Business user: belongs to one business and has one business user role. Business users sign in with email and password or a one-time token (see Auth).
Admin: the first user created in a business becomes its admin.
Deactivation: users are never deleted, only deactivated (active: false). Deactivating a user cancels their upcoming KIO Link events and removes them from releases.
Datacenter access (dc_access): the days, hours and locations the user may visit, always within the business's datacenters.
Two-factor authentication: admins can reset a user's daily code limits or toggle 2FA for a user.
Audit trail: creations and deactivations are recorded.
"My" endpoints (releasesstatus, alertsstatus, delete-account) act on the signed-in business user and require no permission.

Endpoints#

List business users by business#

GET /v1/businessusers
Every business user, grouped by business.

List a business's users#

GET /v1/businessusers/{businessid}
Every user of a business.

Create a business user#

POST /v1/businessusers/{businessid}
Creates or reactivates a user and sends the welcome email.

Get a business user#

GET /v1/businessusers/{businessid}/user/{id}
Returns a user of a business.

Update a business user#

PATCH /v1/businessusers/{businessid}/user/{id}
Updates a user's profile.

Upload a business user's avatar#

PATCH /v1/businessusers/{businessid}/user/{id}/avatar
Uploads a user's avatar.

Delete a business user's avatar#

DELETE /v1/businessusers/{businessid}/user/{id}/avatar
Removes a user's avatar.

Deactivate business users#

PATCH /v1/businessusers/business/{businessid}/delete
Deactivates several users.

Search business users#

GET /v1/businessusers/search/{query}
Up to 10 active users by name or email.

Search a business's users#

GET /v1/businessusers/search/{query}/business/{businessid}
Users of a business by name or email.

Send a password reset email to a business user#

GET /v1/businessusers/{businessid}/user/{id}/resetpassword
Emails a user a password reset link.

Reset a business user's daily sign-in code limits#

GET /v1/businessusers/{businessid}/user/{id}/reset-token-ots
Resets a user's daily sign-in code limits.

Toggle a business user's two-factor authentication#

GET /v1/businessusers/user/{id}/toggle-two-factor-auth
Turns 2FA off or on for a user.

Export all business users#

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

Import business users from CSV#

POST /v1/business/users/import
Intended to create users from CSV (currently broken).

Set whether I receive releases#

PATCH /v1/businessusers/releasesstatus
Opts the signed-in user in or out of releases.

Set whether I receive alerts#

PATCH /v1/businessusers/alertsstatus
Opts the signed-in user in or out of alerts.

Request the deletion of my account#

DELETE /v1/businessusers/delete-account
Asks the KIO admins to delete the signed-in user's account.

Source#

Router: routes/v1/business.js
Controllers: controllers/business/business-users.js, controllers/business.js
Models: models/business_user.js, models/business_user_access_token.js, models/records.js
Services: services/mailing.js, services/s3.js
Email templates: newUser, resetPassword, delete-account
Modified at 2026-10-05 20:40:40
Previous
Overview
Next
List business users by business
Built with