createuser
createuser — define a newPostgreSQL user account
Synopsis
createuser [connection-option...] [option...] [username]
Description
createuser creates a newPostgreSQL user (or more precisely, a role). Only superusers and users withCREATEROLE privilege can create new users, socreateuser must be invoked by someone who can connect as a superuser or a user withCREATEROLE privilege.
If you wish to create a role with theSUPERUSER,REPLICATION, orBYPASSRLS privilege, you must connect as a superuser, not merely withCREATEROLE privilege. Being a superuser implies the ability to bypass all access permission checks within the database, so superuser access should not be granted lightly.CREATEROLE also conveysvery extensive privileges.
createuser is a wrapper around theSQL commandCREATE ROLE. There is no effective difference between creating users via this utility and via other methods for accessing the server.
Options
createuser accepts the following command-line arguments:
usernameSpecifies the name of thePostgreSQL user to be created. This name must be different from all existing roles in thisPostgreSQL installation.
-arole--with-admin=roleSpecifies an existing role that will be automatically added as a member of the new role with admin option, giving it the right to grant membership in the new role to others. Multiple existing roles can be specified by writing multiple
-aswitches.-cnumber--connection-limit=numberSet a maximum number of connections for the new user. The default is to set no limit.
-d--createdbThe new user will be allowed to create databases.
-D--no-createdbThe new user will not be allowed to create databases. This is the default.
-e--echoEcho the commands thatcreateuser generates and sends to the server.
-E--encryptedThis option is obsolete but still accepted for backward compatibility.
-grole--member-of=role--role=(deprecated)roleSpecifies the new role should be automatically added as a member of the specified existing role. Multiple existing roles can be specified by writing multiple
-gswitches.-i--inheritThe new role will automatically inherit privileges of roles it is a member of. This is the default.
-I--no-inheritThe new role will not automatically inherit privileges of roles it is a member of.
--interactivePrompt for the user name if none is specified on the command line, and also prompt for whichever of the options
-d/-D,-r/-R,-s/-Sis not specified on the command line. (This was the default behavior up to PostgreSQL 9.1.)-l--loginThe new user will be allowed to log in (that is, the user name can be used as the initial session user identifier). This is the default.
-L--no-loginThe new user will not be allowed to log in. (A role without login privilege is still useful as a means of managing database permissions.)
-mrole--with-member=roleSpecifies an existing role that will be automatically added as a member of the new role. Multiple existing roles can be specified by writing multiple
-mswitches.-P--pwpromptIf given,createuser will issue a prompt for the password of the new user. This is not necessary if you do not plan on using password authentication.
-r--createroleThe new user will be allowed to create, alter, drop, comment on, change the security label for other roles; that is, this user will have
CREATEROLEprivilege. Seerole creation for more details about what capabilities are conferred by this privilege.-R--no-createroleThe new user will not be allowed to create new roles. This is the default.
-s--superuserThe new user will be a superuser.
-S--no-superuserThe new user will not be a superuser. This is the default.
-vtimestamp--valid-until=timestampSet a date and time after which the role's password is no longer valid. The default is to set no password expiry date.
-V--versionPrint thecreateuser version and exit.
--bypassrlsThe new user will bypass every row-level security (RLS) policy.
--no-bypassrlsThe new user will not bypass row-level security (RLS) policies. This is the default.
--replicationThe new user will have the
REPLICATIONprivilege, which is described more fully in the documentation forCREATE ROLE.--no-replicationThe new user will not have the
REPLICATIONprivilege, which is described more fully in the documentation forCREATE ROLE. This is the default.-?--helpShow help aboutcreateuser command line arguments, and exit.
createuser also accepts the following command-line arguments for connection parameters:
-hhost--host=hostSpecifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket.
-pport--port=portSpecifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.
-Uusername--username=usernameUser name to connect as (not the user name to create).
-w--no-passwordNever issue a password prompt. If the server requires password authentication and a password is not available by other means such as a
.pgpassfile, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.-W--passwordForcecreateuser to prompt for a password (for connecting to the server, not for the password of the new user).
This option is never essential, sincecreateuser will automatically prompt for a password if the server demands password authentication. However,createuser will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing
-Wto avoid the extra connection attempt.
Environment
PGHOSTPGPORTPGUSERDefault connection parameters
PG_COLORSpecifies whether to use color in diagnostic messages. Possible values are
always,autoandnever.
This utility, like most otherPostgreSQL utilities, also uses the environment variables supported bylibpq (seeSection 32.15).
Diagnostics
In case of difficulty, seeCREATE ROLE andpsql for discussions of potential problems and error messages. The database server must be running at the targeted host. Also, any default connection settings and environment variables used by thelibpq front-end library will apply.
Examples
To create a userjoe on the default database server:
$createuser joe
To create a userjoe on the default database server with prompting for some additional attributes:
$createuser --interactive joeShall the new role be a superuser? (y/n)nShall the new role be allowed to create databases? (y/n)nShall the new role be allowed to create more new roles? (y/n)n
To create the same userjoe using the server on hosteden, port 5000, with attributes explicitly specified, taking a look at the underlying command:
$createuser -h eden -p 5000 -S -D -R -e joeCREATE ROLE joe NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN;
To create the userjoe as a superuser, and assign a password immediately:
$createuser -P -s -e joeEnter password for new role:xyzzyEnter it again:xyzzyCREATE ROLE joe PASSWORD 'md5b5f5ba1a423792b526f799ae4eb3d59e' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;
In the above example, the new password isn't actually echoed when typed, but we show what was typed for clarity. As you see, the password is encrypted before it is sent to the client.