MCP Tools Reference: cloud-sql

Ferramenta: list_users

Listar todos os usuários de banco de dados de uma instância do Cloud SQL.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta list_users MCP.

Solicitação curl 
                  
curl --location 'https://sqladmin.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_users",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

SqlUsersListRequest

Representação JSON 
{
  "instance": string,
  "project": string
}
Campos
instance

string

ID da instância do banco de dados. Isso não inclui o ID do projeto.
project

string

ID do projeto com a instância.

Esquema de saída

Resposta da lista de usuários.

UsersListResponse

Representação JSON 
{
  "kind": string,
  "items": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Esse valor é sempre sql#usersList.
items[]

object (User)

Lista de recursos do usuário na instância.
nextPageToken
(deprecated)

string

Não utilizado.

Usuário

Representação JSON 
{
  "kind": string,
  "password": string,
  "etag": string,
  "name": string,
  "host": string,
  "instance": string,
  "project": string,
  "type": enum (SqlUserType),
  "iamEmail": string,
  "passwordPolicy": {
    object (UserPasswordValidationPolicy)
  },
  "databaseRoles": [
    string
  ],

  // Union field user_details can be only one of the following:
  "sqlserverUserDetails": {
    object (SqlServerUserDetails)
  }
  // End of list of possible types for union field user_details.

  // Union field _dual_password_type can be only one of the following:
  "dualPasswordType": enum (DualPasswordType)
  // End of list of possible types for union field _dual_password_type.

  // Union field _iam_status can be only one of the following:
  "iamStatus": enum (IamStatus)
  // End of list of possible types for union field _iam_status.
}
Campos
kind

string

Esse valor é sempre sql#user.
password

string

A senha do usuário.
etag

string

Este campo está obsoleto e será removido da versão futura da API.
name

string

O nome do usuário na instância do Cloud SQL. Pode ser omitido para update porque já está especificado no URL.
host

string

Opcional. O host a partir do qual o usuário pode se conectar. Para operações insert, o padrão do host é uma string vazia. Para operações update, o host é especificado como parte do URL da solicitação. O nome do host não pode ser atualizado após a inserção. Para uma instância do MySQL, é obrigatório. Para uma instância do PostgreSQL ou do SQL Server, é opcional.
instance

string

O nome da instância do Cloud SQL. Isso não inclui o ID do projeto. Pode ser omitido para update porque já está especificado no URL.
project

string

O código do projeto que contém o banco de dados do Cloud SQL. O domínio do Google Apps tem o prefixo, se aplicável. Pode ser omitido para update porque já está especificado no URL.
type

enum (SqlUserType)

O tipo de usuário. Ele determina o método para autenticar o usuário durante o login. O padrão é o tipo de usuário integrado do banco de dados.
iamEmail

string

Opcional. O e-mail completo de um usuário do IAM. Para usuários normais do banco de dados, esse campo não será preenchido. Aplicável apenas a usuários do banco de dados MySQL.
passwordPolicy

object (UserPasswordValidationPolicy)

Política de validação de senha no nível do usuário.
databaseRoles[]

string

Opcional. Associações de função do usuário
Campo de união user_details. Os detalhes do usuário para o tipo de banco de dados específico user_details podem ser apenas um dos seguintes:
sqlserverUserDetails

object (SqlServerUserDetails)

Campo de união _dual_password_type.

_dual_password_type pode ser apenas de um dos tipos a seguir:
dualPasswordType

enum (DualPasswordType)

Status de senha dupla para o usuário.

Campo de união _iam_status.

_iam_status pode ser apenas de um dos tipos a seguir:
iamStatus

enum (IamStatus)

Indica se um grupo está ativo ou inativo para a autenticação de banco de dados do IAM.

SqlServerUserDetails

Representação JSON 
{
  "disabled": boolean,
  "serverRoles": [
    string
  ]
}
Campos
disabled

boolean

Se o usuário tiver sido desativado
serverRoles[]

string

As funções do servidor para este usuário

UserPasswordValidationPolicy

Representação JSON 
{
  "allowedFailedAttempts": integer,
  "passwordExpirationDuration": string,
  "enableFailedAttemptsCheck": boolean,
  "status": {
    object (PasswordStatus)
  },
  "enablePasswordVerification": boolean
}
Campos
allowedFailedAttempts

integer

Número de tentativas de login com falha permitidas antes do bloqueio do usuário.
passwordExpirationDuration

string (Duration format)

Duração da validade após a atualização da senha.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
enableFailedAttemptsCheck

boolean

Se for "true", a verificação de tentativas de login com falha será ativada.
status

object (PasswordStatus)

Apenas saída. Status de senha somente leitura.
enablePasswordVerification

boolean

Se for "true", o usuário precisará especificar a senha atual antes de mudar a senha. Essa flag é compatível apenas com o MySQL.

Duração

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo seconds 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal do campo seconds. Precisa estar entre -999.999.999 e +999.999.999 (inclusive).

PasswordStatus

Representação JSON 
{
  "locked": boolean,
  "passwordExpirationTime": string
}
Campos
locked

boolean

Se for "true", o usuário não terá privilégios de login.
passwordExpirationTime

string (Timestamp format)

O prazo de validade da senha atual.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ❌ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌