mng.CreateUser

This job creates a new user. A new record is created in the DB table benutzer. ID and osguid are generated by the job and returned in XML.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Currently not supported — pass 0.

UserInfo

BASE64

Yes

Properties of the user in XML format (see below).

HasEncoding

BOOL

Yes

UserInfo contains encoding (e.g., UTF-8).

[PlainPassword]

BOOL

No

If present and 1, the password is taken from the XML in plaintext and encrypted. If one-time passwords are not configured, this causes an error.

2. UserInfo Structure

<AdmInfo>
  <Users>
    <User account_type="0" benutzer="USER" flags="1" loginName="USER"
          geaendert="1" langid="0" locked="0" logincount="0"
          logintime="0" name="Peter Muster"
          passwort="B62441422712357307" profil="-1" server_id="3"
          supervisor="0"/>
  </Users>
</AdmInfo>
Attribute Type Description

account_type

INT

Login type: 0 = user login; 1 = application server; 2 = ANONYMOUS; 3 = application server (e.g., Java server)

bemerkung

STRING

Comment from user configuration

benutzer

STRING

Username

loginName

STRING

Login name

flags

INT

0 = normal user; 1 = server or ANONYMOUS

geaendert

INT

0 = profile not changed; 1 = profile was changed

id

INT

ID of the user (set by the job)

langid

INT

ID of the used language (empty = German)

locked

INT

1 = user is locked, otherwise 0

logincount

INT

Number of login attempts

loginstation

STRING

Name of the last login station

logintime

INT

Login timestamp

name

STRING

Full name of the user

osemail

STRING

User’s email

osguid

STRING

GUID of the user (set by the job)

passwort

STRING

Encrypted password of the user

profil

INT

-1 = no profile; 0 = user profile; >0 = ID of assigned profile

server_id

INT

ID of the server

station

STRING

Name of the user’s workstation

supervisor

INT

-1 = supervisor, otherwise 0

validfrom

INT

User account valid from (timestamp)

validto

INT

User account valid to (timestamp)

3. Output Parameters

Name Type Dependency Description

UserInfo

BASE64

—

Properties of the user in XML format — id and osguid are set.

4. Return Value

(INT): 0 = Job successful, otherwise error code.

5. Required System Role

This job accesses the security system or user and group data and therefore requires the calling user to hold system role 4 (Administrator: Configure security system — configure the rights system). If this role is missing, the call is rejected with the error code -1040906164; the associated error text reads:

User {username} does not have permission to configure the security system. Please contact your administrator.

The system roles assigned to the calling user can be determined with mng.GetUserRoles; an overview of all roles is available under System Roles. See also Error Codes.