Skip to main content

Create Accounts Directly

Create accounts or associate existing organization accounts in a private deployment. This API requires administrator permissions and is unavailable in SaaS.

Endpoint: /openapi/v1/account/inviteUser

Method: POST

Request parameters

The request body is an array of account objects. Do not wrap the array in an object.

ParameterTypeRequiredDescription
nameStringYesAccount name or login name.
createBooleanYestrue creates an account and generates an initial password. false associates an existing organization account.
roleIdLongNoRole ID to assign to the account.

Request example

[
{
"name": "new_user",
"create": true,
"roleId": 1001
}
]

Response parameters

ParameterTypeDescription
successBooleanWhether the request succeeded.
requestIdStringRequest ID.
dataArrayResults of the account creation or association.
data[].nameStringAccount name.
data[].passwordStringInitial password, returned only for a newly created account.

Success response

{
"success": true,
"requestId": "<requestId>",
"data": [
{
"name": "new_user",
"password": "<initialPassword>"
}
]
}