| home > API > [/server/user_info] > |
| request url |
https://[SERVER]:[PORT]/server/user_info[?PARAMETER1=value[&...]] |
| short description |
Shows information about user |
| long description |
Returns user's id, name and groups. |
| parameters |
| name |
type |
description |
| show_permission |
boolean |
If 1 then additional information about the user's permissions on right objects is returned (optional, default is 0) |
| show_info |
boolean |
If 1 then additional info fields are returned - license key and description |
| show_gpuflag |
boolean |
If 1 then the status of the gpu engine (enabled/disabled) is returned (optional, default is 0) |
| sid |
string |
Session identifier for a server connection. Use the
/server/login request to get a valid
session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
id |
identifier |
User id |
| 1 |
name |
string |
User name |
| 2 |
groups |
identifier |
Comma separated list of user's groups |
| 3 |
group_names |
string |
Comma separated list of user's group names |
| 4 |
ttl |
string |
Timeout interval in seconds. If no request is
made within this interval the session becomes inactive. |
| 5 |
permission |
string |
Comma separated list of permissions on right objects, maximum over all groups/roles ("N", "R", "W", "D", "S") for each object |
| 6 |
license |
string |
License key |
| 7 |
description |
string |
session description if provided by client |
| 8 |
enabled_gpu |
boolean |
1 if gpu engine is enabled, otherwise 0. |
|
| examples |
|
| further information |
|