python-openstackclient/doc/source/command-objects/role.rst
Hidekazu Nakamura 3f532a2b69 Remove backticks from help in role commands
the docs and code had inconsistencies with how it
references other arguments, lets just remove the
backticks from around them.

Change-Id: I43d17b07364e45387c6b9d86c2aca26eeea8ed93
2015-09-19 00:40:21 -04:00

5.0 KiB

role

Identity v2, v3

role add

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

role add

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

--domain <domain>

Include <domain> (name or ID)

3

--project <project>

Include <project> (name or ID)

--user <user>

Include <user> (name or ID)

--group <group>

Include <group> (name or ID)

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3

--inherited

Specifies if the role grant is inheritable to the sub projects.

3

<role>

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

role create

Create new role

role create

os role create
    [--or-show]
    <name>

--or-show

Return existing role

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

<name>

New role name

role delete

Delete role(s)

role delete

os role delete
    <role> [<role> ...]

<role>

Role to delete (name or ID)

role list

List roles

role list

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

--domain <domain>

Filter roles by <domain> (name or ID)

3

--project <project>

Filter roles by <project> (name or ID)

3

--user <user>

Filter roles by <user> (name or ID)

3

--group <group>

Filter roles by <group> (name or ID)

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3

--inherited

Specifies if the role grant is inheritable to the sub projects.

3

role remove

Remove role from domain/project : user/group

role remove

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

--domain <domain>

Include <domain> (name or ID)

3

--project <project>

Include <project> (name or ID)

--user <user>

Include <user> (name or ID)

--group <group>

Include <group> (name or ID)

3

--user-domain <user-domain>

Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3

--group-domain <group-domain>

Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.

3

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3

--inherited

Specifies if the role grant is inheritable to the sub projects.

3

<role>

Role to remove (name or ID)

role set

Set role properties

3

role set

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

--name <name>

Set role name

<role>

Role to modify (name or ID)

role show

Display role details

role show

os role show
    <role>

<role>

Role to display (name or ID)