GetRoles

Retrieve roles’ information.

Parameters

[optional] roles: list of roles for which the information will be retrieved. By default, all roles will be retrieved.
[optional] objects: indicates if permissions for objects will be retrieved.
[optional] indexes: indicates if permissions for indexes will be retrieved.
[optional] access_control: indicates if permissions for access_control will be retrieved.

Details

By default, all permissions for all roles will be retrieved.

Examples

Retrieve all roles’ information for roles “researcher” and “admin”, using GetRoles command:

[ {
    "GetRoles" : {
        "roles": ["researcher", "admin"],
        "objects": True,
        "indexes": True,
        "access_control": True,

    }
} ]

# Response:

[ {
    "GetRoles": {
        "status": 0,
        "researcher": {
            "objects": {
                "create": True,
                "read":   True,
                "update": False,
                "delete": False,
            },
            "indexes": {
                "create": False,
                "read":   False,
                "update": False,
                "delete": False,
            },
            "access_control": {
                "create": False,
                "read":   False,
                "update": False,
                "delete": False,
            },
        },
        "admin": {
            "objects": {
                "create": True,
                "read":   True,
                "update": True,
                "delete": True,
            },
            "indexes": {
                "create": True,
                "read":   True,
                "update": True,
                "delete": True,
            },
            "access_control": {
                "create": True,
                "read":   True,
                "update": True,
                "delete": True,
            },
        },
    }
}]