summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/group.rst
blob: 3e7e806f17314c1508f8f39b0bf03fb38ee0e44f (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
181
182
183
184
185
186
187
188
189
190
191
192
=====
group
=====

Identity v3

group add user
--------------

Add user to group

.. program:: group add user
.. code:: bash

    os group add user
        <group>
        <user>

.. describe:: <group>

    Group to contain <user> (name or ID)

.. describe:: <user>

    User to add to <group> (name or ID)

group contains user
-------------------

Check user membership in group

.. program:: group contains user
.. code:: bash

    os group contains user
        <group>
        <user>

.. describe:: <group>

    Group to check (name or ID)

.. describe:: <user>

   User to check (name or ID)

group create
------------

Create new group

.. program:: group create
.. code:: bash

    os group create
        [--domain <domain>]
        [--description <description>]
        [--or-show]
        <group-name>

.. option:: --domain <domain>

    Domain to contain new group (name or ID)

.. option:: --description <description>

    New group description

.. option:: --or-show

    Return existing group

    If the group already exists, return the existing group data and do not fail.

.. describe:: <group-name>

    New group name

group delete
------------

Delete group

.. program:: group delete
.. code:: bash

    os group delete
        [--domain <domain>]
        <group> [<group> ...]

.. option:: --domain <domain>

    Domain containing group(s) (name or ID)

.. describe:: <group>

    Group(s) to delete (name or ID)

group list
----------

List groups

.. program:: group list
.. code:: bash

    os group list
        [--domain <domain>]
        [--user <user>]
        [--long]

.. option:: --domain <domain>

    Filter group list by <domain> (name or ID)

.. option:: --user <user>

    Filter group list by <user> (name or ID)

.. option:: --long

    List additional fields in output

group remove user
-----------------

Remove user from group

.. program:: group remove user
.. code:: bash

    os group remove user
        <group>
        <user>

.. describe:: <group>

    Group containing <user> (name or ID)

.. describe:: <user>

    User to remove from <group> (name or ID)

group set
---------

Set group properties

.. program:: group set
.. code:: bash

    os group set
        [--name <name>]
        [--domain <domain>]
        [--description <description>]
        <group>

.. option:: --name <name>

    New group name

.. option:: --domain <domain>

    New domain to contain <group> (name or ID)

.. option:: --description <description>

    New group description

.. describe:: <group>

    Group to modify (name or ID)

group show
----------

Display group details

.. program:: group show
.. code:: bash

    os group show
        [--domain <domain>]
        <group>

.. option:: --domain <domain>

    Domain containing <group> (name or ID)

.. describe:: <group>

    Group to display (name or ID)