KIO Link
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
KIO Link XC APIKIO Link API
KIO BMSHuawei BMSHuawei Alert
  1. Businesses
  • 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
      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. Businesses

Overview

Businesses#

Client businesses (companies) registered in KIO Link, and everything attached to them: users, roles, devices, racks, consoles, datacenter access and visit reports.

Concepts#

Business: identified by _id and by its Salesforce Account ID (id_salesforce), which the CSV imports use to match rows. name is unique.
Status (active): 1 = active, 0 = suspended. Users of a suspended business cannot sign in.
Datacenters: the datacenter locations and phases the business may use. Business users' datacenter access is always trimmed to them.
Extra data: key/value pairs (clave/valor) such as num_sap (shown as sap in lists), project_manager or service_delivery_manager.
Traffic light (traffic_light) and pre-authorization (preauthorization): event authorization settings. Changes are logged and notified.
Deleting a business also deletes all of its business users.

Subfolders#

Business Users: users of a business, plus the signed-in user's own settings.
Business Roles and Business Permissions: roles and permissions of business users.
Business Consoles: console access data of a business.
Business Devices: client devices and their transfers.
Business Racks: racks and cages assigned to a business.
Business Locations: business status and datacenters, plus legacy migrations.
Business Reports: periodic visit reports.

Endpoints#

List businesses#

GET /v1/business
Businesses with optional skip/limit paging and an active filter.

Search businesses#

GET /v1/business/list/query
Up to 100 businesses whose name contains the text.

Search businesses by name or extra data#

GET /v1/businessusers/search-business/{query}
Up to 10 businesses whose name or extra data matches the text.

Get a business#

GET /v1/business/{id}
Returns a business with its report recipients.

Create a business#

POST /v1/business
Creates a business.

Update a business#

PATCH /v1/business/{id}
Updates a business and trims its users' datacenter access.

Delete a business#

DELETE /v1/business/{id}
Deletes a business and its users.

Export businesses#

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

Import businesses from CSV#

POST /v1/business/import
Creates or updates businesses from CSV, by Salesforce ID.

Source#

Router: routes/v1/business.js
Controller: controllers/business.js
Model: models/business.js
Service: services/logs.js
Email template: trafficlight
Modified at 2026-10-05 20:40:40
Previous
Delete application content
Next
Overview
Built with