---
title: "User Management"
description: "This page explains the procedures for various user management tasks under TigerGraph's RBAC authorization model."
component: "tigergraph-server"
version: "3.10"
module: "user-access"
html_url: "/tigergraph-server/3.10/user-access/user-management"
canonical_url: "https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/user-management"
markdown_url: "https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/user-management.md"
---

[View as HTML](https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/user-management)

# User Management

This page explains the procedures for various user management tasks under TigerGraph's role-based access control(RBAC) model.

To see user management tasks under the [Access Control List (ACL)](https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/access-control-model.md#_access_control_lists) model, see [Access Control Lists (ACLs)](https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/acl-management.md).

## Create a user

You can run the `CREATE USER` command to create a user.

## Username Rules for v3.9.3 and above

> [!NOTE]
> v3.9.3 expanded the variety of characters users can access while creating a username from previous versions.

> [!NOTE]
> A username is treated as a `STRING` in GSQL, regardless of the syntax structure, format, or characters used.

**Usernames** may contain any Unicode characters **except** the following:

1. May not contain these characters: `\r`, `\n`, `\0`, `\b`, `\t`, `\a`, `\v`.
2. May not contain any `SPACE`.

> [!NOTE]
> In the GSQL client, backquotes ( `` ` `` ) must be used as a delimiter to enclose usernames which is not a valid email and does not follow the pattern \[a-zA-Z\_\]\[a-zA-Z0-9\]\*. Delimiters are not stored internally.

## Username Rules for v3.9.2 and below

> [!NOTE]
> For v3.9.2 and below please follow these guidelines when creating a username.

**Usernames** must match a regex pattern of `[a-zA-Z_][a-zA-Z0-9]*`, or be an email. You may also use non-ascii characters, such as Chinese and Kanji characters.

Additionally, usernames may **not** contain the following characters:

1. `\`, `(`, `)`, `[`, `]`, `:`, `<`, `>`, `;`, `,`, `@`, `\r`, `\n`, `\f`, `\t`, `\\`, `\0`, `\b`.
2. A username may not start with a dot ( `.` ) or have multiple dots ( `…​` or `a.b..c…​` ) in a sequence.

> [!NOTE]
> Backquotes ( `` ` `` ) must be used as a delimiter to enclose usernames which do not follow the pattern `[a-zA-Z_][a-zA-Z0-9]*`. Delimiters are not stored internally.

### Syntax

```gsql
CREATE USER
```

### Required privilege

`WRITE_USER`

### Procedure

1. From the GSQL shell, run the `CREATE USER` command:  
```gsql  
GSQL > CREATE USER  
```
2. Enter the user information in the prompts that follow:  
Example 1: Create user  
```console  
User Name : user1  
New Password : ************  
Re-enter Password : ************  
The user "user1" is created.  
```  
Example 2: Create user with email  
```console  
User Name : a@b.com  
New Password : ************  
Re-enter Password : ************  
The user "a@b.com" is created.  
```  
Example 3: Create user with special characters (**Only** v3.9.3)  
```console  
User Name : `:"/.,@#$%^*()_+=-`  
New Password : ************  
Re-enter Password : ************  
The user ":"/.,@#$%^*()_+=-" is created.  
```

#### Non-Interactive Mode

Run the command like this to run `create user` in non-interactive mode.

Example:

```console
GSQL > create user -u user1 -p pass1
```

> [!NOTE]
> for special case use "`“ username“`" to include the username

## View roles assignments and login attempts

The `SHOW USER` command displays the role assignments, as well as the login attempts, of the current user. If the current user has the `READ_USER` privilege

### Syntax

```gsql
SHOW USER
```

### Required privilege

`READ_USER` for displaying roles of other users

### Procedure

From the GSQL shell, run the `SHOW USER` command:

```gsql
GSQL > SHOW USER
- Name: testUser
    - Global Roles: superuser
    - LastSuccessLogin: Thu Sep 22 12:43:07 UTC 2022
    - NextValidLogin: Thu Sep 22 12:43:07 UTC 2022 (1)
    - FailedAttempts: 0
    - ShowAlterPasswordWarning: false
```

| **1** | The next time the user is allowed to attempt login. For more information, see [Configuring Login Protection](https://www.tigergraph.com/docs/tigergraph-server/3.10/security/login-protection.md) |
| --- | --- |

If the user running the command has the `READ_USER` privilege, information on all users is displayed. Otherwise, only the current user's information is displayed.

## View privileges of a user or proxy group

Users with the `READ_USER` privilege in a scope can view the RBAC privileges of users or proxy groups within that scope.

### Syntax

```gsql
SHOW PRIVILEGE ON USER <username> (, <username>)*
SHOW PRIVILEGE ON USER <proxygroup> (, <proxygroup>)*
```

### Required privilege

`READ_USER`

### Procedure

1. From the GSQL shell, run the `SHOW PRIVILEGE ON USER` command with either a username or proxy group name:  
```gsql  
GSQL > SHOW PRIVILEGE ON USER tigergraph  
```  
or

GSQL > SHOW PRIVILEGE ON USER proxy_group1

The command displays the privileges assigned to the specified user or proxy group.

```text
User: "tigergraph"
  - Global Privileges:
    READ_SCHEMA
    WRITE_SCHEMA
    READ_LOADINGJOB
    EXECUTE_LOADINGJOB
    WRITE_LOADINGJOB
    READ_QUERY
    WRITE_QUERY
    READ_DATA
    WRITE_DATA
    WRITE_DATASOURCE
    READ_ROLE
    WRITE_ROLE
    READ_USER
    WRITE_USER
    READ_PROXYGROUP
    WRITE_PROXYGROUP
    READ_FILE
    WRITE_FILE
    DROP_GRAPH
    EXPORT_GRAPH
    CLEAR_GRAPHSTORE
    DROP_ALL
    ACCESS_TAG
```

When you run the command for a proxy group, it displays the privileges granted to that proxy group.

```text
ProxyGroup: "proxy_group1"
  - Global Privileges:
    READ_DATA
    WRITE_DATA
    READ_USER
    READ_PROXYGROUP
```

To view [ACL privileges](<https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/access-control-model.md#<em>access_control_lists>) of a user, see [View ACL privileges of a user](<https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/acl-management.md#_view_acl_privileges_of_a_user</em>>).

## Grant a role to a user or proxy group

### Syntax

```gsql
GRANT ROLE <role_name1> (, role_name2)* [ON GRAPH <graph_name>]
  TO <username1>|<proxy_group_name1> (, <username2> | <proxy_group_name>2)*
```

### Required privilege

`WRITE_ROLE`

### Procedure

1. Start the GSQL shell and make sure you are using the correct graph  
```console  
$ gsql  
GSQL > USE GRAPH example_graph  
```
2. From the GSQL shell, run the `GRANT ROLE` command. You can grant multiple roles to multiple users:  
```gsql  
GSQL > GRANT ROLE role1 , role2 ON GRAPH example_graph TO user1, user2  
```

The above command will grant roles `role1` and `role2` on graph `example_graph` to users `user1` and `user2`.

## Revoke a role from a user

### Syntax

```gsql
REVOKE ROLE <roleName1> (, <roleName2)* [ON GRAPH <graphName>]
        FROM <userName1> (, <userName2>)*
```

### Required privilege

`WRITE_ROLE`

### Procedure

1. Start the GSQL shell and make sure you are using the correct graph  
```console  
$ gsql  
GSQL > USE GRAPH example_graph  
```
2. From the GSQL shell, run the `REVOKE_ROLE` command. You can revoke multiple roles from multiple users at the same time:  
```gsql  
GSQL > REVOKE ROLE role1, role2 ON GRAPH example_graph  
        FROM user1, user2  
```

The above command will revoke roles `role1` and `role2` on graph `example_graph` from users `user1` and `user2`.

## Change a user's password

Users can change their own passwords used for login without needing any privilege. Users with the `WRITE_USER` privilege can change the passwords of other users.

### Syntax

```gsql
ALTER PASSWORD <username>
```

### Required privilege

`WRITE_USER` for changing the password of a user other than the current user

### Procedure

1. From the GSQL shell, run the following command. Replace `username` with the user whose password you want to change  
```gsql  
GSQL > ALTER PASSWORD username  
```
2. Enter the new password in the prompt that follows.

> [!NOTE]
> To see how to change a user's [ACL password](https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/access-control-model.md#_acl_password), see [Change ACL password](https://www.tigergraph.com/docs/tigergraph-server/3.10/user-access/acl-management.md#_change_acl_password) 

#### Non-Interactive Mode

Run the command like this to run `alter password` in non-Interactive Mode.

Example:

```console
GSQL > alter password -u user1 -p pass2
```

## Drop a user

### Syntax

```gsql
DROP USER <user1> (,<user2>)*
```

### Required privilege

`WRITE_USER`

### Procedure

1. From the GSQL shell, run the `DROP USER` command. You can drop multiple users in the same command.  
```gsql  
GSQL > DROP USER user1, a@b.com, `:"/.,@#$%^*()_+=-`  
```
2. GSQL will confirm that the users you entered have been dropped
