- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Auftragstypen
- User-Auftragstypen
User Create
Funktion
Der Auftragstyp UserCreate legt einen neuen Benutzer an.
Wird beim Anlegen eines neuen Benutzers kein Passwort angegeben, erzeugt das System automatisch eines (15 Zeichen lang). Es ist in der Systemantwort enthalten.
Beschreibung
Route: POST /user
{
"user": "subuser",
"context": 4,
"defaultEmail": "customer@example.com",
"password": "PASSWORD"
}{
"stid": "20211102-test-7757",
"status": {
"code": "S1301001",
"text": "Benutzer wurde erfolgreich angelegt.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser, 4",
"data": {
"context": 4,
"user": "subuser"
}
}
}Hauptbenutzer legt einen direkten Unterbenutzer mit automatischer Passwort-Generierung an.
{
"user": "subuser",
"context": 4,
"defaultEmail": "customer@example.com"
}{
"stid": "20211102-test-7824",
"messages": [
{
"text": "Das Passwort wurde automatisch vom System generiert.",
"objects": [
{
"type": "password",
"value": "$)%MR.+7?bT<^C="
}
],
"code": "MSG13004",
"status": "NOTICE"
}
],
"status": {
"code": "S1301001",
"text": "Benutzer wurde erfolgreich angelegt.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser, 4",
"data": {
"context": 4,
"user": "subuser"
}
}
}Hauptbenutzer legt für seinen Unterbenutzer einen Unterbenutzer an.
{
"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": "Benutzer wurde erfolgreich angelegt.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser-of-subuser-2, 4",
"data": {
"context": 4,
"user": "subuser-of-subuser-2"
}
}
}Auftragstyp-Code: 1301001
Verwendet Objekt User
Hauptbenutzer legt einen direkten Unterbenutzer an.
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>1301001</code>
<user>
<user>sub-customer</user>
<password>PASSWORD</password>
<status>2</status>
<substatus>2</substatus>
<default_mail>sub-customer@example.com</default_mail>
<language>de</language>
</user>
</task>
</request><response>
<result>
<data />
<status>
<code>S1301001</code>
<text>Benutzer wurde erfolgreich angelegt.</text>
<type>success</type>
<object>
<type>user</type>
<value>sub-customer, 4</value>
</object>
</status>
</result>
<stid>20211102-test-7362</stid>
</response>Hauptbenutzer legt einen direkten Unterbenutzer mit automatischer Passwort-Generierung an.
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>1301001</code>
<user>
<user>sub-customer</user>
<status>2</status>
<substatus>2</substatus>
<default_mail>sub-customer@example.com</default_mail>
<language>de</language>
</user>
</task>
</request><response>
<result>
<data/>
<msg>
<text>Das Passwort wurde automatisch vom Systen angelegt.</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>sub-customer, 4</value>
</object>
<text></text>
<type>success</type>
</status>
</result>
<stid>20211102-test-7362</stid>
</response>Hauptbenutzer legt für seinen Unterbenutzer einen Unterbenutzer an.
<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>Benutzer wurde erfolgreich angelegt.</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>Beispiel mit optionalem <user_mail_key>
<request>
<auth>
<user>customer</user>
<context>password</context>
<password>4</password>
</auth>
<task>
<code>1301001</code>
<user>
<user>newuser</user>
<password>password</password>
<status>2</status>
<substatus>2</substatus>
<default_mail>EMAIL</default_mail>
<language>en</language>
<user_mail_keys>
<user_mail_key>
<public_key><![CDATA[-----BEGIN PGP PUBLIC KEY BLOCK----- ... -----END PGP PUBLIC KEY BLOCK-----]]></public_key>
<fingerprint><![CDATA[bc295893f3ec94ac9fb5c7530b0b7b8ad42d76f8]]></fingerprint>
<type>PGP</type>
</user_mail_key>
</user_mail_keys>
</user>
</task>
</request><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>