Personal Access Token
The gitlab.PersonalAccessToken
resource allows to manage the lifecycle of a personal access token for a specified user.
This resource requires administration privileges. Upstream API: GitLab REST API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.PersonalAccessToken("example", {
userId: 25,
name: "Example personal access token",
expiresAt: "2020-03-14",
scopes: ["api"],
});
const exampleProjectVariable = new gitlab.ProjectVariable("example", {
project: exampleGitlabProject.id,
key: "pat",
value: example.token,
});
Content copied to clipboard
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.PersonalAccessToken("example",
user_id=25,
name="Example personal access token",
expires_at="2020-03-14",
scopes=["api"])
example_project_variable = gitlab.ProjectVariable("example",
project=example_gitlab_project["id"],
key="pat",
value=example.token)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = new GitLab.PersonalAccessToken("example", new()
{
UserId = 25,
Name = "Example personal access token",
ExpiresAt = "2020-03-14",
Scopes = new[]
{
"api",
},
});
var exampleProjectVariable = new GitLab.ProjectVariable("example", new()
{
Project = exampleGitlabProject.Id,
Key = "pat",
Value = example.Token,
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v7/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := gitlab.NewPersonalAccessToken(ctx, "example", &gitlab.PersonalAccessTokenArgs{
UserId: pulumi.Int(25),
Name: pulumi.String("Example personal access token"),
ExpiresAt: pulumi.String("2020-03-14"),
Scopes: pulumi.StringArray{
pulumi.String("api"),
},
})
if err != nil {
return err
}
_, err = gitlab.NewProjectVariable(ctx, "example", &gitlab.ProjectVariableArgs{
Project: pulumi.Any(exampleGitlabProject.Id),
Key: pulumi.String("pat"),
Value: example.Token,
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.PersonalAccessToken;
import com.pulumi.gitlab.PersonalAccessTokenArgs;
import com.pulumi.gitlab.ProjectVariable;
import com.pulumi.gitlab.ProjectVariableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new PersonalAccessToken("example", PersonalAccessTokenArgs.builder()
.userId("25")
.name("Example personal access token")
.expiresAt("2020-03-14")
.scopes("api")
.build());
var exampleProjectVariable = new ProjectVariable("exampleProjectVariable", ProjectVariableArgs.builder()
.project(exampleGitlabProject.id())
.key("pat")
.value(example.token())
.build());
}
}
Content copied to clipboard
resources:
example:
type: gitlab:PersonalAccessToken
properties:
userId: '25'
name: Example personal access token
expiresAt: 2020-03-14
scopes:
- api
exampleProjectVariable:
type: gitlab:ProjectVariable
name: example
properties:
project: ${exampleGitlabProject.id}
key: pat
value: ${example.token}
Content copied to clipboard
Import
A GitLab Personal Access Token can be imported using a key composed of <user-id>:<token-id>
, e.g.
$ pulumi import gitlab:index/personalAccessToken:PersonalAccessToken example "12345:1"
Content copied to clipboard
NOTE: the token
resource attribute is not available for imported resources as this information cannot be read from the GitLab API.
Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
The scope for the personal access token. It determines the actions which can be performed when authenticating with this token. Valid values are: api
, read_user
, read_api
, read_repository
, write_repository
, read_registry
, write_registry
, sudo
, admin_mode
, create_runner
.