python-openstackclient/doc/source/command-objects/role.rst

====
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> [--project-domain <project-domain>]
        --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
        --inherited
        <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

.. option:: --user-domain <user-domain>

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

    .. versionadded:: 3

.. option:: --group-domain <group-domain>

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

    .. versionadded:: 3

.. option:: --project-domain <project-domain>

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

    .. versionadded:: 3

.. option:: --inherited

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

    .. 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
        [--or-show]
        <name>

.. option:: --or-show

    Return existing role

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

.. describe:: <name>

    New role name

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

Delete role(s)

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

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

.. describe:: <role>

    Role to delete (name or ID)

role list
---------

List roles

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

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

.. 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

.. option:: --user-domain <user-domain>

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

    .. versionadded:: 3

.. option:: --group-domain <group-domain>

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

    .. versionadded:: 3

.. option:: --project-domain <project-domain>

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

    .. versionadded:: 3

.. option:: --inherited

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

    .. versionadded:: 3

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

Remove role from domain/project : user/group

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

    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>

.. 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

.. option:: --user-domain <user-domain>

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

    .. versionadded:: 3

.. option:: --group-domain <group-domain>

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

    .. versionadded:: 3

.. option:: --project-domain <project-domain>

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

    .. versionadded:: 3

.. option:: --inherited

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

    .. versionadded:: 3

.. describe:: <role>

    Role to remove (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
---------

Display role details

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

    os role show
        <role>

.. describe:: <role>

    Role to display (name or ID)