tower-cli/docs/source/api_ref/resources/role.rst

RBAC Role
=========

Description
-----------

This resource is used for managing RBAC roles in Tower. More importantly, it can be used for granting roles
to and revoke roles from a user or team.

Fields Table
------------
.. <table goes here>

+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|name          |type                                                        |help_text                                                     |read_only |unique |filterable |required |
+==============+============================================================+==============================================================+==========+=======+===========+=========+
|user          |Resource user                                               |The user field.                                               |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|team          |Resource team                                               |The team that receives the permissions specified by the role. |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|type          |Choices: admin,read,member,execute,adhoc,update,use,auditor |The type of permission that the role controls.                |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|resource_name |String                                                      |The resource_name field.                                      |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|resource_type |String                                                      |The resource_type field.                                      |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|target_team   |Resource team                                               |The team that the role acts on.                               |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|inventory     |Resource inventory                                          |The inventory field.                                          |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|job_template  |Resource job_template                                       |The job_template field.                                       |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|credential    |Resource credential                                         |The credential field.                                         |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|organization  |Resource organization                                       |The organization field.                                       |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|project       |Resource project                                            |The project field.                                            |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+
|workflow      |Resource workflow                                           |The workflow field.                                           |False     |False  |True       |False    |
+--------------+------------------------------------------------------------+--------------------------------------------------------------+----------+-------+-----------+---------+

.. <table goes here>

API Specification
-----------------
.. autoclass:: tower_cli.resources.role.Resource
   :members: copy, get, list, grant, revoke