alloydb-list-users

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. It is compatible with alloydb-admin source. The tool takes the following input parameters:

ParameterTypeDescriptionRequired
projectstringThe GCP project ID to list users for.Yes
clusterstringThe ID of the cluster to list users from.Yes
locationstringThe location of the cluster (e.g., ‘us-central1’).Yes

Example

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

Reference

fieldtyperequireddescription
kindstringtrueMust be alloydb-list-users.
sourcestringtrueThe name of an alloydb-admin source.
descriptionstringfalseDescription of the tool that is passed to the agent.
Last modified September 18, 2025: docs: fix docs linting (#1520) (3d8a041782)