- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- User tasks
User create
Function
The UserCreate tasks creates a new user.
If no password is specified when creating a new user, the system automatically generates one (15 characters long). It is included in the system response.
Description
Route: POST /user
{
"user": "subuser",
"context": 4,
"defaultEmail": "customer@example.com",
"password": "PASSWORD"
}{
"stid": "20211102-test-7757",
"status": {
"code": "S1301001",
"text": "User was successfully created.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser, 4",
"data": {
"context": 4,
"user": "subuser"
}
}
}Main user creates a direct subuser with automatic password generation.
{
"user": "subuser",
"context": 4,
"defaultEmail": "customer@example.com"
}{
"stid": "20211102-test-7824",
"messages": [
{
"text": "The password was automatically generated by the system.",
"objects": [
{
"type": "password",
"value": "$)%MR.+7?bT<^C="
}
],
"code": "MSG13004",
"status": "NOTICE"
}
],
"status": {
"code": "S1301001",
"text": "User was successfully created.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser, 4",
"data": {
"context": 4,
"user": "subuser"
}
}
}Main user creates a subuser for his subuser.
{
"password": "1234abc%",
"defaultEmail": "customer@example.com",
"status": 2,
"substatus": 2,
"user": "subuser-of-subuser",
"language": "de",
"parent": {
"context": 4,
"defaultEmail": "subuser@example.com",
"status": 1,
"substatus": 1,
"authType": "PASSWORD",
"lock": "NONE",
"user": "subuser"
}
}{
"stid": "20211102-app2-dev-110202",
"status": {
"code": "S1301001",
"text": "User was successfully created.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser-of-subuser-2, 4",
"data": {
"context": 4,
"user": "subuser-of-subuser-2"
}
}
}Task code: 1301001
Uses User object
Main user creates a direct subuser.
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>1301001</code>
<user>
<user>subcustomer</user>
<password>PASSWORD</password>
<status>2</status>
<substatus>2</substatus>
<default_mail>subcustomer@example.com</default_mail>
<language>de</language>
</user>
</task>
</request><response>
<result>
<data />
<status>
<code>S1301001</code>
<text>User was successfully created.</text>
<type>success</type>
<object>
<type>user</type>
<value>subcustomer, 4</value>
</object>
</status>
</result>
<stid>20211102-test-7362</stid>
</response>Main user creates a direct subuser with automatic password generation.
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>1301001</code>
<user>
<user>subcustomer</user>
<status>2</status>
<substatus>2</substatus>
<default_mail>subcustomer@example.com</default_mail>
<language>de</language>
</user>
</task>
</request><response>
<result>
<data/>
<msg>
<text>The password was automatically generated by the system.</text>
<code>MSG13004</code>
<type>notice</type>
<object>
<type>password</type>
<value>/WKU;3Pm3%</value>
</object>
</msg>
<status>
<code>S1301001</code>
<object>
<type>user</type>
<value>subcustomer, 4</value>
</object>
<text></text>
<type>success</type>
</status>
</result>
<stid>20211102-test-7362</stid>
</response>Main user creates a subuser for his subuser.
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>1301001</code>
<user>
<user>subuser-of-subuser</user>
<password>password</password>
<context>4</context>
<status>2</status>
<substatus>2</substatus>
<default_mail>Subsubuser@example.com</default_mail>
<language>de</language>
<owner>
<user>subuser</user>
<context>4</context>
</owner>
</user>
</task>
</request><response>
<result>
<data />
<status>
<code>S1301001</code>
<text>User was successfully created.</text>
<type>success</type>
<object>
<type>user</type>
<value>subuser-of-subuser-1, 4</value>
</object>
</status>
</result>
<stid>20211102-app2-dev-101770</stid>
</response>Example with optional <user_mail_key>.
<response >
<result>
<data />
<msg>
<code>MSG13003</code>
<type>notice</type>
<object>
<type>user</type>
<value>newuser, 4</value>
</object>
</msg>
<status>
<code>S1301001</code>
<type>success</type>
<object>
<type>user</type>
<value>newuser, 4</value>
</object>
</status>
</result>
</response>