Updates an existing user in a Cloud SQL instance.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/sqlservice.admin

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: sqladmin1-beta4 --scope <scope> users update ...

Required Scalar Arguments

  • <project> (string)
    • Project ID of the project that contains the instance.
  • <instance> (string)
    • Database instance ID. This does not include the project ID.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

User:
  dual-password-type: string
  etag: string
  host: string
  instance: string
  kind: string
  name: string
  password: string
  password-policy:
    allowed-failed-attempts: integer
    enable-failed-attempts-check: boolean
    enable-password-verification: boolean
    password-expiration-duration: string
    status:
      locked: boolean
      password-expiration-time: string
  project: string
  sqlserver-user-details:
    disabled: boolean
    server-roles: [string]
  type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . dual-password-type=accusam
    • Dual password status for the user.
  • etag=sanctus
    • This field is deprecated and will be removed from a future version of the API.
  • host=duo
    • 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=kasd
    • 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.
  • kind=eos
    • This is always sql#user.
  • name=no
    • The name of the user in the Cloud SQL instance. Can be omitted for update because it is already specified in the URL.
  • password=kasd
    • The password for the user.
  • password-policy allowed-failed-attempts=43
    • Number of failed login attempts allowed before user get locked.
  • enable-failed-attempts-check=true
    • If true, failed login attempts check will be enabled.
  • enable-password-verification=true
    • If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
  • password-expiration-duration=dolor
    • Expiration duration after password is updated.
  • status locked=true
    • If true, user does not have login privileges.

  • password-expiration-time=sea

    • The expiration time of the current password.

  • ... project=diam

    • 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.
  • sqlserver-user-details disabled=false
    • If the user has been disabled

  • server-roles=magna

    • The server roles for this user
    • Each invocation of this argument appends the given value to the array.

  • .. type=accusam

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

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p host=string

    • Optional. Host of the user in the instance.

  • -p name=string

    • Name of the user in the instance.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").