---
title: "user add"
slug: "user-add"
updated: 2026-10-27T17:24:31Z
published: 2026-10-27T17:24:31Z
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 local 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 (VAST Cluster 5.3.2 and later)

```plaintext
user add --name NAME
         --uid UID
        [--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]
        [--local-provider-id ID]
```

## Usage (prior to VAST Cluster 5.3.2)

```plaintext
user add --name NAME
        [--uid UID]
        [--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]
        [--local-provider-id ID]
```

## Required Parameters

| `--name NAME` | Sets the user's name. |
| --- | --- |
| `--uid UID` | Specifies the user's POSIX (NFS) UID attribute. > [!NOTE] > **Note** > > In VAST Cluster 5.3.2, this parameter is optional. |

## Options

| `--uid UID` | Specifies the user's POSIX (NFS) UID attribute. > [!NOTE] > **Note** > > Prior to VAST Cluster 5.3.2, this parameter is required. |
| --- | --- |
| `--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. |
| `--local-provider-id ID` | Specifies a local provider with which the tenant is associated. If not specified, the default provider is used. |