Skip to main content

GetUserDetails

Retrieve one user and the combined permissions of their roles.

Any authenticated user can call this command without an additional CRUD permission. No input or output blobs are used.

Parameters​

Parameter

Type / required

Default and behavior

username

string / required

Name of the user to retrieve; no default, including when retrieving yourself.

Details​

The permissions of all assigned roles are combined. The response includes tokens only when the requester owns the account or has access_control.read permission. Those values are token tags, never full personal token secrets. Other account details are available to any authenticated requester.

Response and recovery​

Success returns status: 0, username, email, roles, and permissions. Each permissions category contains Boolean CRUD fields. tokens is conditional as described above.

Failure or empty result

Cause and recovery

Cannot retrieve user: ...

Verify that the username exists; use GetUsers when you have ACL read permission.

See Responses for validation, authentication, and permission error envelopes. Command errors use a negative status and an info message.

Examples​

Retrieve all user information for user “john”, using GetUserDetails command:

[{
"GetUserDetails": {
"username": "john"
}
}]

Sample result from a system with a user “john”:

[{
"GetUserDetails": {
"username": "john",
"status": 0,
"roles": ["architect", "user"],
"email": "jfk@aperturedata.io",
"permissions": {
"objects": {
"create": true,
"read": true,
"update": false,
"delete": false
},
"indexes": {
"create": true,
"read": true,
"update": true,
"delete": true
},
"access_control": {
"create": false,
"read": false,
"update": false,
"delete": false
}
}
}
}]