HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. user

Create or update a user account

post
http://127.0.0.1:8080/users

Creates a new user account or updates an existing one. For new users without a password, a reset password email is sent. On cloud orchestrator, two-factor authentication must be enabled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
required

Set to true to create a new user, false to update existing user. Required parameter.

Body Params

User account details for creation or update.

Request body for creating or updating a user account.

string
required
^([a-zA-Z0-9_.\-])+$|^[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Login username. Must be alphanumeric with underscores, dots, dashes, or a valid email format. Cannot be changed after creation.

string
required

User's first name for display purposes.

string
required

User's last name for display purposes.

string
required

User's email address. Required if password is not provided (for new user invitation). Used for password reset and email-based TFA.

string
required

User's phone number for contact purposes.

password
required
length between 8 and 64

User's password. Must be 8-64 characters with uppercase, lowercase, digit, and special character. Cannot contain username. Leave empty to send password reset email (requires email).

password
required

Must match the password field exactly for confirmation.

string
enum
required

User role determining permissions. Admin Manager has full read/write access. Network Monitor has read-only access.

Allowed:
string
enum
required

Account status. Active users can log in. Inactive users are disabled but retained in the system.

Allowed:
boolean
required
Defaults to false

Enable email-based two-factor authentication. On cloud orchestrator, at least one TFA method must be enabled.

boolean
required
Defaults to false

Enable app-based (TOTP) two-factor authentication. On cloud orchestrator, at least one TFA method must be enabled.

string
required

Primary key of the user. Leave empty for new user creation. Required for updates to identify the user record.

string
required

Display-formatted creation time. Optional field for UI purposes.

boolean

Indicates if user has set initial password. Used during updates to determine if email is required.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated about 11 hours ago

Did this page help you?