---
title: "user add"
slug: "user-add"
tags: ["5.5"]
updated: 2026-10-27T23:00:54Z
published: 2026-10-27T23:00:54Z
canonical: "docs.vastdata.com/user-add"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# user add

This command lets you manually add a user to the VAST provider and, optionally, grant S3 permissions to the users.

> [!TIP]
> Tip
> 
> The newly created user needs an S3 access key pair to be able to create or access S3 buckets. Run `user generate-key` to generate a key pair. To enable the key pair, run `user modify-key`.

#### Usage

```plaintext
user add --name NAME
         --uid UID
         --vast-provider-id ID
        [--leading-group-gid LEADING_GID]
        [--groups-gids GIDs]
        [--allow-create-bucket|--disallow-create-bucket]
        [--allow-delete-bucket|--disallow-delete-bucket]
        [--s3-superuser|--not-s3-superuser]
        [--identity-policies-ids IDs]
        [--password PASSWORD]
```

#### Required Parameters

| `--name NAME` | Sets the user's name. |
| --- | --- |
| `--vast-provider-id ID` | Specifies a VAST provider with which the tenant is associated. |

#### Options

| `--uid UID` | Specifies the user's POSIX (NFS) UID attribute. |
| --- | --- |
| `--leading-group-gid LEADING_GID` | The group ID (GID) of the user's leading group. The leading group is the owning group of any files created by the user. If no local group with the specified GID exists, it is created. For example: `--leading-gid 44` |
| `--groups-gids GIDs` | The group IDs (GIDs) of groups to which the user belongs. Enter the GIDs as a comma-separated list. The first group listed is the default leading group. For example: `--gids 5,65,102,170` |
| `--allow-create-bucket` | Allows the user to create buckets when connecting to the cluster via S3. |
| `--disallow-create-bucket` | Prohibits the user to create buckets when connecting to the cluster via S3. |
| `--allow-delete-bucket` | Allows the user to delete buckets when connecting to the cluster via S3. |
| `--disallow-delete-bucket` | Prohibits the user to delete buckets when connecting to the cluster via S3. |
| `--s3-superuser` | Grants the user S3 superuser permission, which enables the user to override S3 ACLs. > [!NOTE] > **Note** > > This is a legacy feature. VAST S3 Superuser permission is only available if it was set for a user prior to upgrade to version 5.2. |
| `--not-s3-superuser` | Removes S3 superuser permission from the user. |
| `--identity-policies-ids IDs` | Assigns one or more S3 identity policies to the user. Specify a comma-separated list of policy IDs. |
| `--password PASSWORD` | Set a temporary initial password for the user to PASSWORD. The user will be requested to change this password on the first login. The password must meet the requirements configured in the VMS settings. |