summaryrefslogtreecommitdiff
path: root/src/commands/acl-getuser.json
blob: 535389bc530635297453c9044e33848ebaa7780a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
    "GETUSER": {
        "summary": "Lists the ACL rules of a user.",
        "complexity": "O(N). Where N is the number of password, command and pattern rules that the user has.",
        "group": "server",
        "since": "6.0.0",
        "arity": 3,
        "container": "ACL",
        "function": "aclCommand",
        "history": [
            [
                "6.2.0",
                "Added Pub/Sub channel patterns."
            ],
            [
                "7.0.0",
                "Added selectors and changed the format of key and channel patterns from a list to their rule representation."
            ]
        ],
        "command_flags": [
            "ADMIN",
            "NOSCRIPT",
            "LOADING",
            "STALE",
            "SENTINEL"
        ],
        "arguments": [
            {
                "name": "username",
                "type": "string"
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "a set of ACL rule definitions for the user",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "flags": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        },
                        "passwords": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        },
                        "commands": {
                            "description": "root selector's commands",
                            "type": "string"
                        },
                        "keys": {
                            "description": "root selector's keys",
                            "type": "string"
                        },
                        "channels": {
                            "description": "root selector's channels",
                            "type": "string"
                        },
                        "selectors": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "commands": {
                                        "type": "string"
                                    },
                                    "keys": {
                                        "type": "string"
                                    },
                                    "channels": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "description": "If user does not exist",
                    "type": "null"
                }
            ]
        }
    }
}