Appliance can provide information about stored users; you can get information about all users from all repository. You can not get this information only about one user, not as users’ list. This information available only for full administrators.
To get user information use the resource with URI:
/users?user_name={user_name}&login_session_id={login_session_id}
The resource has URI parameters
Table 3-25 The parameter for get information about user
|
URI parameter |
Description |
|---|---|
|
user_name |
The user name, appliance will return information about this user |
|
login_session_id |
The login session identifier, the identifier of login session for user with administrative role |
The resource will return JSON object with user information.
Table 3-26 The object with information about user
|
Parameter name |
Description |
|---|---|
|
id |
The user identifier |
|
repo_id |
The repository identifier |
|
obj_id |
The user identifier in repository |
|
repo_name |
The repository name |
|
loginame |
The user name in repository |
|
user_name |
The user name with repository, repo\user_name |
On the following example, administrator with login session identifier “cdlsXhjaEHOaPiwTlOck5p0xGaqgkNJB” will try to get information about user JSmith from COMPANY repository.
HTTP GET
https://authserver.example.com/api/v1/users?user_name=COMPANY\JSmith&login_session_id=cdlsXhjaEHOaPiwTlOck5p0xGaqgkNJB
Response
{
"repo_id":"cd2ce1fa65eb11e58f04000c2951aca4",
"obj_id":"373bf00f9421394ab36c69f9d82283e4",
"id":"395e14fc65ec11e58f04000c2951aca4",
"user_name":"COMPANY\\John Smith",
"loginame":"JSmith",
"repo_name":"COMPANY",
}