summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/role.rst
blob: 1cc80d7d9809f54b14210e339f075aef760140da (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
====
role
====

Identity v2, v3

role add
--------

Add role to a user or group in a project or domain

.. program:: role add
.. code:: bash

    os role add
        --domain <domain> | --project <project>
        --user <user> | --group <group>
        <role>

.. option:: --domain <domain>

    Include `<domain>` (name or ID)

    .. versionadded:: 3

.. option:: --project <project>

    Include `<project>` (name or ID)

.. option:: --user <user>

    Include `<user>` (name or ID)

.. option:: --group <group>

    Include `<group>` (name or ID)

    .. versionadded:: 3

.. describe:: <role>

    Role to add to `<project>`:`<user>` (name or ID)

role create
-----------

Create new role

.. program:: role create
.. code:: bash

    os role create
        <name>

.. describe:: <name>

    New role name

role delete
-----------

Delete an existing role

.. program:: role delete
.. code:: bash

    os role delete
        <role>

.. option:: <role>

    Role to delete (name or ID)

role list
---------

List roles

.. program:: role list
.. code:: bash

    os role list
        [--domain <domain> | --project <project]
        [--user <user> | --group <group>]

.. option:: --domain <domain>

    Filter roles by <domain> (name or ID)

    .. versionadded:: 3

.. option:: --project <project>

    Filter roles by <project> (name or ID)

    .. versionadded:: 3

.. option:: --user <user>

    Filter roles by <user> (name or ID)

    .. versionadded:: 3

.. option:: --group <group>

    Filter roles by <group> (name or ID)

    .. versionadded:: 3

role remove
-----------

Remove role from domain/project : user/group

.. program:: role remove
.. code:: bash

    os role remove
        [--domain <domain> | --project <project]
        [--user <user> | --group <group>]
        <role>

.. option:: --domain <domain>

    Include `<domain>` (name or ID)

    .. versionadded:: 3

.. option:: --project <project>

    Include `<project>` (name or ID)

.. option:: --user <user>

    Include `<user>` (name or ID)

.. option:: --group <group>

    Include `<group>` (name or ID)

    .. versionadded:: 3

.. describe:: <role>

    Role to remove from `<project>`:`<user>` (name or ID)

role set
--------

Set role properties

.. versionadded:: 3

.. program:: role set
.. code:: bash

    os role set
        [--name <name>]
        <role>

.. option:: --name <name>

    Set role name

.. describe:: <role>

    Role to modify (name or ID)

role show
---------

.. program:: role show
.. code:: bash

    os role show
        <role>

.. describe:: <role>

    Role to show (name or ID)