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

Create a KIO user

QA Environment
https://qa-api.kiolinkapp.com
QA Environment
https://qa-api.kiolinkapp.com
POST
https://qa-api.kiolinkapp.com
/v1/users
Users
Last modified:2026-10-05 20:17:16
Maintainer:Not configured
Required Permission(s):users-users-create
Creates a KIO user.
firstname, email and isBoomiUser are required, and email must have a valid format.
The user is created active (status: true) with a new secret_key; verify_email is set by a Mailgun deliverability check.
role defaults to the Suscriptor role. When keywe is empty, it is initialized with empty HR fields.
The creation is recorded in the user report, and every KIO user with the admin-admin-admin permission and a deliverable email is notified.
If Mailgun validation is not configured on the server, the request never completes.
Requires a session token whose role has the users-users-create permission.

Request

Authorization
API Key
Add parameter in header
authorization
Example:
authorization: ********************
or
Body Params application/jsonRequired

Example
{
  "firstname": "José María",
  "lastname": "Esparza Arévalo",
  "email": "jose.esparza@digitalignition.com.mx",
  "isBoomiUser": false,
  "role": "5adeafca1f301d287fa619a6"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://qa-api.kiolinkapp.com/v1/users' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "firstname": "José María",
  "lastname": "Esparza Arévalo",
  "email": "jose.esparza@digitalignition.com.mx",
  "isBoomiUser": false,
  "role": "5adeafca1f301d287fa619a6"
}'

Responses

🟢200User created
application/json
User created.
Bodyapplication/json

Example
{
    "_id": "65f1c2a9e4b0a1b2c3d4e5e7",
    "firstname": "José María",
    "lastname": "Esparza Arévalo",
    "email": "jose.esparza@digitalignition.com.mx",
    "avatar": "https://lh3.googleusercontent.com/a/abc123",
    "keywe": {
        "empresa": "KIO Networks",
        "id_success_factors": "102345",
        "puesto": "Developer",
        "unidad": "Tecnología",
        "division": "Desarrollo",
        "departamento": "Software",
        "ubicacion": "MEX1",
        "modalidad": "Híbrido"
    },
    "extradata": [],
    "device_tokens": [],
    "role": "5adeafca1f301d287fa619a6",
    "secret_key": "kdjfhgqpwoeirutz",
    "created_at": "2024-03-13T18:22:01.000Z",
    "time_zone": "America/Mexico_City",
    "status": true,
    "isBoomiUser": false,
    "password_limit_date": "2027-01-03T19:00:00.000Z",
    "verify_email": "deliverable",
    "sent_feedback": false,
    "__v": 0
}
🟠400`firstname` or `email` is missing, or `email` has an invalid
🟠401The session token expired
🟠403Not authenticated (missing/invalid token, inactive user), or
🔴500Unexpected error (e
Modified at 2026-10-05 20:17:16
Previous
List KIO users
Next
Get a KIO user
Built with