mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-03 19:55:31 -05:00
3a6b51752f
## Description --- This pull request introduces a new tool, cloud-sql-create-users, which allows for the creation of both built-in and IAM users in a Cloud SQL instance. <img width="518" height="846" alt="image" src="https://github.com/user-attachments/assets/2f96f0be-658b-46d1-9de6-f47db2804274" /> <img width="518" height="956" alt="image" src="https://github.com/user-attachments/assets/2a7d80d4-eab2-4e91-b08b-5fb78c150319" /> ## PR Checklist --- > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here>
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
---
|
|
title: cloud-sql-create-users
|
|
type: docs
|
|
weight: 10
|
|
description: >
|
|
Create a new user in a Cloud SQL instance.
|
|
---
|
|
|
|
The `cloud-sql-create-users` tool creates a new user in a specified Cloud SQL instance. It can create both built-in and IAM users.
|
|
|
|
{{< notice info >}}
|
|
This tool uses a `source` of kind `cloud-sql-admin`.
|
|
{{< /notice >}}
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
create-cloud-sql-user:
|
|
kind: cloud-sql-create-users
|
|
source: my-cloud-sql-admin-source
|
|
description: "Creates a new user in a Cloud SQL instance. Both built-in and IAM users are supported. IAM users require an email account as the user name. IAM is the more secure and recommended way to manage users. The agent should always ask the user what type of user they want to create. For more information, see https://cloud.google.com/sql/docs/postgres/add-manage-iam-users"
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| ------------ | :-------: | :----------: | ------------------------------------------------ |
|
|
| kind | string | true | Must be "cloud-sql-create-users". |
|
|
| description | string | false | A description of the tool. |
|
|
| source | string | true | The name of the `cloud-sql-admin` source to use. |
|