Skip to main content

GetUserDetails

Retrieve a user's information.

Parameters​

  • username: user for which information will be retrieved.

Details​

This command can be used to retrieve a user's information and a summary of the permissions assigned to the user. When a user has multiple roles assigned, the permissions of all roles will be joined and returned.

Note: Token values will be returned only if the user being queried matches the user making the query. Additionally, only a portion of each token value is returned.

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
                }
            }
        }
    }]