Back to Genai Toolbox

alloydb-list-users

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

1.1.01.3 KB
Original Source

About

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

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

Compatible Sources

{{< compatible-sources >}}

Example

yaml
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

fieldtyperequireddescription
typestringtrueMust be alloydb-list-users.
sourcestringtrueThe name of an alloydb-admin source.
descriptionstringfalseDescription of the tool that is passed to the agent.