wanghong e5d71221ad add doc for group command
Change-Id: Iaaa0aeb42f9f940af63863f5d09011b5f7529281
2014-12-24 14:31:12 +08:00

2.8 KiB

group

Identity v3

group add user

Add user to group

group add user

os group add user
    <group>
    <user>

<group>

Group that user will be added to (name or ID)

<user>

User to add to group (name or ID)

group contains user

Check user in group

group contains user

os group contains user
    <group>
    <user>

<group>

Group to check if user belongs to (name or ID)

<user>

User to check (name or ID)

group create

Create new group

group create

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

--domain <domain>

References the domain ID or name which owns the group

--description <description>

New group description

--or-show

Return existing group

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

<group-name>

New group name

group delete

Delete group

group delete

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

--domain <domain>

Domain where group resides (name or ID)

<group>

Group(s) to delete (name or ID)

group list

List groups

group list

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

--domain <domain>

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

--user <user>

List group memberships for <user> (name or ID)

--long

List additional fields in output (defaults to false)

group remove user

Remove user from group

group remove user

os group remove user
    <group>
    <user>

<group>

Group that user will be removed from (name or ID)

<user>

User to remove from group (name or ID)

group set

Set group properties

group set

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

--name <name>

New group name

--domain <domain>

New domain that will now own the group (name or ID)

--description <description>

New group description

<group>

Group to modify (name or ID)

group show

Show group details

group show

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

--domain <domain>

Domain where group resides (name or ID)

<group>

Group to display (name or ID)