LIST ROLES

Lists roles and shows superuser and login status. Roles have DESCRIBE permission on their own and any inherited roles. Only roles that the current user has permission to see are listed. Superusers can see all roles.

This command runs with a consistency level of QUORUM.

SynSyntaxopsis

LIST ROLES [ OF <role_name> ] [ NORECURSIVE ] ;

Syntax legend

Legend
Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`< >`	Variable value. Replace with a user-defined value.
`[]`	Optional. Square brackets (`[]`) surround optional command arguments. Do not type the square brackets.
`( )`	Group. Parentheses ( `( )` ) identify a group to choose from. Do not type the parentheses.
`\|`	Or. A vertical bar (`\|`) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
`...`	Repeatable. An ellipsis ( `...` ) indicates that you can repeat the syntax element as often as required.
`'<Literal string>'`	Single quotation (`'`) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
`{ <key> : <value> }`	Map collection. Braces (`{ }`) enclose map collections or key value pairs. A colon separates the key and the value.
`<datatype2`	Set, list, map, or tuple. Angle brackets ( `< >` ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`<cql_statement>;`	End CQL statement. A semicolon (`;`) terminates all CQL statements.
`[--]`	Separate the command line options from the command arguments with two hyphens ( `--` ). This syntax is useful when arguments might be mistaken for command line options.
`' <<schema\> ... </schema\>> '`	Search CQL only: Single quotation marks (`'`) surround an entire XML schema declaration.
`@<xml_entity>='<xml_entity_type>'`	Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrConfig files.

Parameters

Parameter Description Default

Parameter	Description	Default
`role_name`	Identifier of the role. CQL forces all names to lowercase. If you need to preserve case or use special characters in the role name, enclose <role_name> in quotes.
`NORECURSIVE`	Do not show inherited roles.

role_name

Identifier of the role. CQL forces all names to lowercase. If you need to preserve case or use special characters in the role name, enclose <role_name> in quotes.

NORECURSIVE

Do not show inherited roles.

Examples

List all roles

Show all the roles that the current role has permission to describe.

LIST ROLES;

List roles assigned to a role

Show the roles for a particular role. Sufficient privileges are required to show this information. Superusers can see all roles.

LIST ROLES OF coach;

Results

 role  | super | login | options | datacenters
-------+-------+-------+---------+-------------
 coach | False |  True |        {} |         ALL

(1 rows)

List roles assigned to a role without showing inherited roles

Show the roles for a particular role without showing inherited roles. The NORECURSIVE option is used to show only the roles directly assigned to the role. Sufficient privileges are required to show this information. Superusers can see all roles.

Check all the roles assigned to the sandy role:

LIST ROLES OF sandy;

Results

 role         | super | login | options | datacenters
--------------+-------+-------+---------+-------------
        sandy |  True |  True |        {} |         ALL
    sys_admin |  True |  True |        {} |         ALL
 team_manager | False |  True |        {} |         ALL

(3 rows)

Now check all the roles assigned to the sandy role without showing inherited roles:

LIST ROLES OF sandy NORECURSIVE;

Results

 role         | super | login | options | datacenters
--------------+-------+-------+---------+-------------
        sandy |  True |  True |        {} |         ALL
 team_manager | False |  True |        {} |         ALL

(2 rows)

LIST ROLES

SynSyntaxopsis

Parameters

Examples

List all roles

List roles assigned to a role

List roles assigned to a role without showing inherited roles

Was this helpful?

Give Feedback