ALTER ROLE

Changes password for a role. Allows superuser, login, and other role options to be set.

Synopsis

ALTER ROLE <role_name>
  ( WITH PASSWORD = '<role_password>' )
  [ [ WITH | AND ] LOGIN = ( true | false ) ]
  [ [ WITH | AND ] SUPERUSER = ( true | false ) ]
  [ [ WITH | AND ] OPTIONS = { <custom_options_map> } ] ;

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.
`<<datatype1>,<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.

Options

Options Description Default

Options	Description	Default
`role_name`	Identifier of the role to alter. CQL forces all names to lowercase. If the name contains uppercase letters or special characters, enclose the role name in quotes.
`WITH PASSWORD`	Change the password for the role. Enclose the password in single quotes. Superusers (and roles with appropriate `ALTER PERMISSION`) can change the password of other roles.
`LOGIN`	Optional. Enable or disable `LOGIN` for a role other than the currently logged in role.	false
`SUPERUSER`	Optional. Enable or disable `SUPERUSER` status for another role (other than the currently logged in role). Setting `SUPERUSER` to false revokes permission to create new roles, but it doesn’t automatically revoke the `AUTHORIZE`, `ALTER`, and `DROP` permissions that already exist. Use `true` to enable superuser status.	false
`OPTIONS = { <option_map> }`	Optional. Change or add a map of custom options. Reserved for use with authentication plug-ins. Refer to the authenticator documentation for details.

role_name

Identifier of the role to alter. CQL forces all names to lowercase. If the name contains uppercase letters or special characters, enclose the role name in quotes.

WITH PASSWORD

Change the password for the role. Enclose the password in single quotes.

Superusers (and roles with appropriate ALTER PERMISSION) can change the password of other roles.

LOGIN

Optional. Enable or disable LOGIN for a role other than the currently logged in role.

false

SUPERUSER

Optional. Enable or disable SUPERUSER status for another role (other than the currently logged in role). Setting SUPERUSER to false revokes permission to create new roles, but it doesn’t automatically revoke the AUTHORIZE, ALTER, and DROP permissions that already exist. Use true to enable superuser status.

false

OPTIONS = { <option_map> }

Optional. Change or add a map of custom options. Reserved for use with authentication plug-ins. Refer to the authenticator documentation for details.

Example

Change the password for a role

A role can change the password for itself or another role that it has permission to modify. A superuser can change the password of any role.

Use ALTER to change a role’s password:

ALTER ROLE sandy WITH PASSWORD = 'bestTeam';

Alter a role to enable SUPERUSER status

ALTER ROLE sandy WITH SUPERUSER=true;

Alter a role to enable LOGIN privileges

ALTER ROLE team_manager WITH LOGIN=true;

ALTER ROLE

Synopsis

Options

Example

Was this helpful?

Give Feedback