Sign in
projects

Creates a new User in a given project and location and Server.

post/v1/{+parent}/users

Request

  • Base URL: https://ftp.googleapis.com
  • URL: https://ftp.googleapis.com/v1/{+parent}/users
  • 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

parentstring required

Required. Value for parent.

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

userIdstring

Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.

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.