Authorization - Get ProMark users

API Url

Get a specific username from ProMark

GET

http://localhost:16010/ProMarkREST/web/Auth/users/{username}

Permissions: sysop

Path parameters

Field	Type	Description
username`optional`	String	Who to query in ProMark.

Query parameters

Field	Type	Description
filter`optional`	String	Query expression used for filtering the records. Example: filter=username eq 'John' or firstName begins 'John'.
skip`optional`	Number	How many records to skip.
sortBy`optional`	String	Query expression used to sort the resulted records. Example: sortBy=username.
take`optional`	Number	How many records to load.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
users	Object[]
disabled	Boolean	TRUE if the user is disabled. Will not allow authentication.
firstName	String	First name of the user.
id	Number	Unique identifier.
isAdministrator	Boolean	TRUE if the user account has administrator privileges.
lastName	String	Last name of the user.
locked	Boolean	TRUE if the user is active but locked out. Will not allow authentication.
roles`optional`	Number[]	List of ProMark roles the user holds. 1=Employee, 2=User.
username	String	Login username used for authenticating into ProMark.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "users": [
            {
               "id": 1000,
               "username": "john@domain.com",
               "firstName": "John",
               "lastName": "Doe",
               "roles": [
                     1,
                     2
               ],
               "disabled": false,
               "locked": false,
               "isAdministrator": true
            }
         ]
      }
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.