GET user/get?LoginName={LoginName}&Token={Token}

Retrieve personal data for specific user. Application privilege "View" for licensed agenda "Users" required. Data may also be restricted by record permission "View" of agenda "User"

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
LoginName

Identification of the user in the system

 string

Required

String length: inclusive between 0 and 100
Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

 globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Successfully done
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 1401 Privilege View of agenda Users violated for [LoginName {0}]
403 server refuses fo fulfill the request 1412 Record permission View of agenda User violated for [{0}]
403 server refuses fo fulfill the request 1402 System user is not accessible by API
404 required resource does not exist on the server 1400 User LoginName [{0}] not found
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error Server exception description

Resource Description

UserGetResp
NameDescriptionTypeAdditional information
UserName

Name of the user in the system

 string

None.
Roles

List of user roles

 Collection of string

None.
TimeLastChange

The last change time of the data record. Can be used to check manual modification of data record

 date

None.
LoginName

Unique identification of the user in the system

 string

None.
VerificationNT

User domain verification flag. The value "1" means verified by domain and value "0" means verified local.

 integer

None.
ValidFrom

The user is valid from

 date

None.
ValidTo

The user is valid to

 date

None.
Lock

User lock flag. The value "0" means unlocked and value "1" means locked.

 integer

None.
PersonID

Person ID assigned to the user

 string

None.

Response Formats

application/json

Sample: 
{"LoginName":"John.Doo","VerificationNT":1,"ValidFrom":"\/Date(1546326000000)\/","ValidTo":"\/Date(1609484400000)\/","Lock":0,"PersonID":null,"UserName":"John Doo","Roles":["Administrators","Users"],"TimeLastChange":"\/Date(1733227751540)\/"}

application/xml

Sample: 

<Response>
  <LoginName>John.Doo</LoginName>
  <VerificationNT>1</VerificationNT>
  <ValidFrom>2019-01-01T08:00:00</ValidFrom>
  <ValidTo>2021-01-01T08:00:00</ValidTo>
  <Lock>0</Lock>
  <Roles>
    <string>Administrators</string>
    <string>Users</string>
  </Roles>
  <TimeLastChange>2024-12-03T12:09:11.5402981Z</TimeLastChange>
</Response>

text/json

Sample: 
{
  "Roles": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample: 
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Roles>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Roles>
</Response>