Sign in
projects

Updates the parameters of a single User.

patch/v1/{+name}

Request

  • Base URL: https://ftp.googleapis.com
  • URL: https://ftp.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}

Query parameters

updateMaskstring

Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.

updateMaskstring

Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.

Request body

labelsobject

Optional. Labels as key value pairs

updateTimestring google-datetime

Output only. [Output only] Update time stamp

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'ERROR' | 'UPDATING' | 'DELETING'

Output only. Tracks user creation.

createTimestring google-datetime

Output only. [Output only] Create time stamp

usernamestring

Output only. [Output only] The username of the user.

namestring

Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}

customerServiceAccountstring

Required. Service account in customer project attached to this SFTP User.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.