Skip to main content

GetUserDetails

Read one user, their roles, effective permissions, and token tags.

Requires a valid session; reading another user requires access_control.read. No input or output blobs are used.

Parameters​

  • username (string, required): existing user.

Behavior​

Effective permissions combine every assigned role. Token tags identify personal tokens for removal; they cannot authenticate. Passwords and complete token values are never returned.

Response​

Success returns status: 0, username, email, roles, permissions, and tokens (personal-token tags). Failures return a negative status and an info message; see Responses for error envelopes and retry guidance.

Examples​

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

Response:

[{
    "GetUserDetails": {
        "username": "john",
        "tokens": [],
        "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
            }
        }
    }
}]