alloydb-get-user

The “alloydb-get-user” tool retrieves details for a specific AlloyDB user.

About

The alloydb-get-user tool retrieves detailed information for a single, specified AlloyDB user. It is compatible with alloydb-admin source.

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

Note This tool authenticates using the credentials configured in its alloydb-admin source which can be either Application Default Credentials or client-side OAuth.

Example

tools:
  get_specific_user:
    kind: alloydb-get-user
    source: my-alloydb-admin-source
    description: Use this tool to retrieve details for a specific AlloyDB user.

Reference

fieldtyperequireddescription
kindstringtrueMust be alloydb-get-user.
sourcestringtrueThe name of an alloydb-admin source.
descriptionstringtrueDescription of the tool that is passed to the agent.