/docs/en/integrations/alloydb-admin/tools/alloydb-list-users.md

title, type, weight, description

title	type	weight	description
alloydb-list-users	docs	1	The "alloydb-list-users" tool lists all database users within an AlloyDB cluster.

About

The alloydb-list-users tool lists all database users within an AlloyDB cluster.

The tool takes the following input parameters:

Parameter	Type	Description	Required
project	string	The GCP project ID to list users for.	Yes
cluster	string	The ID of the cluster to list users from.	Yes
location	string	The location of the cluster (e.g., 'us-central1').	Yes

Compatible Sources

{{< compatible-sources >}}

Example

kind: tool
name: list_users
type: alloydb-list-users
source: alloydb-admin-source
description: Use this tool to list all database users within an AlloyDB cluster

Reference

field	type	required	description
type	string	true	Must be alloydb-list-users.
source	string	true	The name of an alloydb-admin source.
description	string	false	Description of the tool that is passed to the agent.