Page tree

Provides access to the users available in the application.

URL:

/editor/user/[ID]

Available Methods:

GET / POST / PUT / DELETE

Specialities:

If an empty password field is given on PUT, password will be reset and user is requested by email to set a new password.

Resource Layout

Name

Type

Info

id

int

GET only

userGuid

string

GET only, set by server

firstName

string

 

surName

string

 

gender

string

 

login

string

 

email

string

 

roles

string

Comma separated string of valid system roles.

passwd

string

optional, settable by PUT / POST only, value is not returned by API

  • If whole field is omitted on PUT, no password change is done
  • If a empty passwd is given on POST, the user receives an email to set his password

editable

boolean

GET only, set by server

locale

string

GET only, set by server

sourceLanguagestringArray of numeric language IDs. The stored language IDs define the source languages for that user.
targetLanguagestringArray of numeric language IDs. The stored language IDs define the target languages for that user.
parentIdsstring

POST / PUT to the server: When saving that value a single user ID or userGuid is allowed. The whole array of parent users is generated on the server.

Result from the server: Array of numeric user IDs. All users referenced by the returned IDs are parent Users of the current one.

Example: [3, 80, 61] that means:
61 is the ID of the direct parent of the current user.
80 is the ID of the direct parent of the user. with ID 61.
3 is the ID of the direct parent of the user. with ID 80.

customersstringids from the clients for this user, for example ',3,' or ',1,3,' (commas are needed for searching)
  • No labels