REST Resource: users.environments

• Resource: Environment
  • JSON representation
• Methods

Resource: Environment

A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default".

JSON representation
{ "name": string, "id": string, "dockerImage": string, "state": enum(State), "sshUsername": string, "sshHost": string, "sshPort": number, "publicKeys": [ { object(PublicKey) } ] }

Fields
name	string Output only. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/[e-mail]/environments/default.
id	string Output only. The environment's identifier, which is always "default".
dockerImage	string Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
state	enum(State) Output only. Current execution state of this environment.
sshUsername	string Output only. Username that clients should use when initiating SSH sessions with the environment.
sshHost	string Output only. Host to which clients can connect to initiate SSH sessions with the environment.
sshPort	number Output only. Port to which clients can connect to initiate SSH sessions with the environment.
publicKeys[]	object(PublicKey) Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the publicKeys.create and publicKeys.delete methods.

Methods
authorize	Sends OAuth credentials to a running environment on behalf of a user.
get	Gets an environment.
patch	Updates an existing environment.
start	Starts an existing environment, allowing clients to connect to it.