Skip to main content
POST
/
platform
/
admin
/
users
Create Platform User
curl --request POST \
  --url https://api.example.com/platform/admin/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe"
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Establishes a new platform user account with administrator privileges. Platform users can manage tenants, configurations, and system-wide settings.

​
Input

Expects a JSON body containing:
  • email (string, required) — Email address for the new platform user.
  • firstName (string, optional) — First name of the user.
  • lastName (string, optional) — Last name of the user.

​
Output

Returns a Result of PlatformUserModel containing:
  • data — The newly created platform user with identifier and status.
  • success (bool) — Indicates whether the operation succeeded.
  • errors (array) — Collection of error messages if the operation failed.

​
Examples

Request 
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe"
}
Response (200 OK) 
{
  "success": true,
  "data": {
    "id": 5,
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "isEnabled": true,
    "invitationStatus": "Pending"
  },
  "errors": []
}

​
Errors

  • 400 Bad Request: Invalid email format or missing required fields.
  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks platform administrator privileges.
  • 409 Conflict: User with specified email already exists.
  • 500 Internal Server Error: Unexpected server error occurred.

​
Notes

Requires platform administrator privileges. An invitation email is automatically sent to the provided email address. The user must accept the invitation to gain access.

Query Parameters

​
api-version
string | null

Body

application/json

The platform user creation request containing email and optional name information.

Platform user creation request body.

​
email
string

Email address for the new platform user account.

Example:

"[email protected]"

​
firstName
string

First name of the platform user.

Example:

"Jane"

​
lastName
string

Last name of the platform user.

Example:

"Doe"

Response

User created and invitation sent successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "id": 5,
  "isEnabled": true,
  "userId": 1
}