REST Resource: users

Resource: User

A Cloud SQL user resource.

JSON representation 
{
  "kind": string,
  "password": string,
  "etag": string,
  "name": string,
  "host": string,
  "instance": string,
  "project": string,
  "type": enum (SqlUserType),
  "sqlserverUserDetails": {
    object (SqlServerUserDetails)
  }
}
Fields
kind

string

This is always sql#user.
password

string

The password for the user.
etag

string

This field is deprecated and will be removed from a future version of the API.
name

string

The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
host

string

Optional. The host from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
instance

string

The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update because it is already specified on the URL.
project

string

The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update because it is already specified on the URL.
type

enum (SqlUserType)

The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
sqlserverUserDetails

object (SqlServerUserDetails)

SqlUserType

The user type.

Enums
BUILT_IN The database's built-in user type.
CLOUD_IAM_USER Cloud IAM user.
CLOUD_IAM_SERVICE_ACCOUNT Cloud IAM service account.
CLOUD_IAM_GROUP Cloud IAM group. Not used for login.
CLOUD_IAM_GROUP_USER Read-only. Login for a user that belongs to the Cloud IAM group.
CLOUD_IAM_GROUP_SERVICE_ACCOUNT Read-only. Login for a service account that belongs to the Cloud IAM group.

SqlServerUserDetails

Represents a Sql Server user on the Cloud SQL instance.

JSON representation 
{
  "disabled": boolean,
  "serverRoles": [
    string
  ]
}
Fields
disabled

boolean

If the user has been disabled
serverRoles[]

string

The server roles for this user

Methods

delete

 Deletes a user from a Cloud SQL instance.

get

 Retrieves a resource containing information about a user.

insert

 Creates a new user in a Cloud SQL instance.

list

 Lists users in the specified Cloud SQL instance.

update

 Updates an existing user in a Cloud SQL instance.