PersonalAccessToken

class PersonalAccessToken : KotlinCustomResource

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 examplePersonalAccessToken = new gitlab.PersonalAccessToken("examplePersonalAccessToken", {
userId: 25,
expiresAt: "2020-03-14",
scopes: ["api"],
});
const exampleProjectVariable = new gitlab.ProjectVariable("exampleProjectVariable", {
project: gitlab_project.example.id,
key: "pat",
value: examplePersonalAccessToken.token,
});
import pulumi
import pulumi_gitlab as gitlab
example_personal_access_token = gitlab.PersonalAccessToken("examplePersonalAccessToken",
user_id=25,
expires_at="2020-03-14",
scopes=["api"])
example_project_variable = gitlab.ProjectVariable("exampleProjectVariable",
project=gitlab_project["example"]["id"],
key="pat",
value=example_personal_access_token.token)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var examplePersonalAccessToken = new GitLab.PersonalAccessToken("examplePersonalAccessToken", new()
{
UserId = 25,
ExpiresAt = "2020-03-14",
Scopes = new[]
{
"api",
},
});
var exampleProjectVariable = new GitLab.ProjectVariable("exampleProjectVariable", new()
{
Project = gitlab_project.Example.Id,
Key = "pat",
Value = examplePersonalAccessToken.Token,
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
examplePersonalAccessToken, err := gitlab.NewPersonalAccessToken(ctx, "examplePersonalAccessToken", &gitlab.PersonalAccessTokenArgs{
UserId: pulumi.Int(25),
ExpiresAt: pulumi.String("2020-03-14"),
Scopes: pulumi.StringArray{
pulumi.String("api"),
},
})
if err != nil {
return err
}
_, err = gitlab.NewProjectVariable(ctx, "exampleProjectVariable", &gitlab.ProjectVariableArgs{
Project: pulumi.Any(gitlab_project.Example.Id),
Key: pulumi.String("pat"),
Value: examplePersonalAccessToken.Token,
})
if err != nil {
return err
}
return nil
})
}
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 examplePersonalAccessToken = new PersonalAccessToken("examplePersonalAccessToken", PersonalAccessTokenArgs.builder()
.userId("25")
.expiresAt("2020-03-14")
.scopes("api")
.build());
var exampleProjectVariable = new ProjectVariable("exampleProjectVariable", ProjectVariableArgs.builder()
.project(gitlab_project.example().id())
.key("pat")
.value(examplePersonalAccessToken.token())
.build());
}
}
resources:
examplePersonalAccessToken:
type: gitlab:PersonalAccessToken
properties:
userId: '25'
expiresAt: 2020-03-14
scopes:
- api
exampleProjectVariable:
type: gitlab:ProjectVariable
properties:
project: ${gitlab_project.example.id}
key: pat
value: ${examplePersonalAccessToken.token}

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"

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
val active: Output<Boolean>

True if the token is active.

Link copied to clipboard
val createdAt: Output<String>

Time the token has been created, RFC3339 format.

Link copied to clipboard
val expiresAt: Output<String>

The token expires at midnight UTC on that date. The date must be in the format YYYY-MM-DD.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the personal access token.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val revoked: Output<Boolean>

True if the token is revoked.

Link copied to clipboard
val scopes: Output<List<String>>

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.

Link copied to clipboard
val token: Output<String>

The personal access token. This is only populated when creating a new personal access token. This attribute is not available for imported resources.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val userId: Output<Int>

The id of the user.