---
title: "user query-by-prefix"
slug: "user-query-by-prefix"
updated: 2026-10-27T17:24:31Z
published: 2026-10-27T17:24:31Z
canonical: "docs.vastdata.com/user-query-by-prefix"
---

> ## 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 query-by-prefix

This command queries Active Directory domains for users by name prefix. It returns identifiers for users whose names share a specified prefix.

> [!TIP]
> Tip
> 
> The identifier for a given user can be provided in a [view modify](/docs-5-3/docs/en/view-modify) command as `--share-ace-identifier` in order to configure an share-level ACE for the user. view modify

##### Usage

```plaintext
user  query-by-prefix --fqdn FQDN|ALL
                      --prefix PREFIX
                      [--active-directory-id ID]
                      [--tenant-id ID]
```

##### Required Parameters

| `--fqdn FQDN\|ALL` | Specifies either a specific fully qualified domain name of a joined Active Directory domain or 'ALL' to query all AD domains to which the cluster is joined. |
| --- | --- |
| `--prefix PREFIX` | Specifies a string prefix to query for users on the specified domain. |

##### Options

| `--active-directory-id ID` | Specifies the ID of Active Directory configuration under which user domains are searched for. |
| --- | --- |
| `--tenant-id ID` | Limits the search to the tenant specified with the tenant ID. |

##### Example

```plaintext
vcli: admin> user query-by-prefix --fqdn ad.arandomorg.com VastENG.lab --prefix com
+-------+-------------------+-----------------+----------------------------------------------+
| Name  | FQDN              | Identifier type | Identifier                                   |
+-------+-------------------+-----------------+----------------------------------------------+
| comet | ad.arandomorg.com | sid_str         | S-x-x-xx-xxxxxxxxx-xxxxxxxxxx-xxxxxxxx-xxxxx |
+-------+-------------------+-----------------+----------------------------------------------+
```

##### Command Output

| `Name` | Name of a user. |
| --- | --- |
| `FQDN` | Fully qualified domain name of a joined Active Directory domain. |
| `Identifier type` | Identifier attribute. Can be either: - `sid_str`. User's SID attribute. - `uid_or_gid`. User's UID number attribute. |
| `Identifier` | Identifier of type specified as `Identifier type`. |