UserGet

This function returns data of one or more LiveConfig users. If the login field is left empty, the data of all existing users will be returned, otherwise only those with the specified user name.

In order to receive all users of a certain customer, his customer number must be passed in the field cid.

Request

Field

Type

RegExp

Null?

Description

auth

AuthData

no

Authentication data

cid

long

^\d{1,18}$

yes

Customer number

login

string

^[\w.-_]{2,50}$

yes

User name

Response

Field

Type

RegExp

Null?

Description

users

UserDetails[]

yes

Array with user data

The format of the user data (UserDetails) is:

Field

Type

Null?

Description

login

string

no

User name (LiveConfig login)

locked

integer

no

Status (0: active, 1: disabled)

contact

string

no

Contact ID of the user


Last updated on Apr 13, 2020.
next: Lua API
previous: UserEdit