CreateEnvironmentAccessToken

client.environments.createEnvironmentToken(, ?): EnvironmentCreateEnvironmentTokenResponse { accessToken }

POST/gitpod.v1.EnvironmentService/CreateEnvironmentAccessToken

Creates an access token for the environment.

Generated tokens are valid for one hour and provide environment-specific access permissions. The token is scoped to a specific environment.

Examples

Generate environment token:

Creates a temporary access token for accessing an environment.
```
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
```

ParametersExpand Collapse

body: EnvironmentCreateEnvironmentTokenParams { environmentId }

environmentId: string

environment_id specifies the environment for which the access token should be created.

formatuuid

ReturnsExpand Collapse

EnvironmentCreateEnvironmentTokenResponse { accessToken }

accessToken: string

access_token is the token that can be used for environment authentication

CreateEnvironmentAccessToken

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.environments.createEnvironmentToken({
  environmentId: '07e03a28-65a5-4d98-b532-8ea67b188048',
});

console.log(response.accessToken);

{
  "accessToken": "accessToken"
}

Returns Examples

{
  "accessToken": "accessToken"
}