pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/UserImpersonationTokenArgs

UserImpersonationTokenArgs

data class UserImpersonationTokenArgs(val expiresAt: Output<String>? = null, val name: Output<String>? = null, val scopes: Output<List<String>>? = null, val userId: Output<Int>? = null) : ConvertibleToJava<UserImpersonationTokenArgs>

The gitlab.UserImpersonationToken resource allows to manage impersonation tokens of users. Requires administrator access. Token values are returned once. You are only able to create impersonation tokens to impersonate the user and perform both API calls and Git reads and writes. The user can’t see these tokens in their profile settings page. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const _this = new gitlab.UserImpersonationToken("this", {
    userId: 12345,
    name: "token_name",
    scopes: ["api"],
    expiresAt: "2024-08-27",
});

import pulumi
import pulumi_gitlab as gitlab
this = gitlab.UserImpersonationToken("this",
    user_id=12345,
    name="token_name",
    scopes=["api"],
    expires_at="2024-08-27")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    var @this = new GitLab.UserImpersonationToken("this", new()
    {
        UserId = 12345,
        Name = "token_name",
        Scopes = new[]
        {
            "api",
        },
        ExpiresAt = "2024-08-27",
    });
});

package main
import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewUserImpersonationToken(ctx, "this", &gitlab.UserImpersonationTokenArgs{
			UserId: pulumi.Int(12345),
			Name:   pulumi.String("token_name"),
			Scopes: pulumi.StringArray{
				pulumi.String("api"),
			},
			ExpiresAt: pulumi.String("2024-08-27"),
		})
		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.UserImpersonationToken;
import com.pulumi.gitlab.UserImpersonationTokenArgs;
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 this_ = new UserImpersonationToken("this", UserImpersonationTokenArgs.builder()
            .userId(12345)
            .name("token_name")
            .scopes("api")
            .expiresAt("2024-08-27")
            .build());
    }
}

resources:
  this:
    type: gitlab:UserImpersonationToken
    properties:
      userId: 12345
      name: token_name
      scopes:
        - api
      expiresAt: 2024-08-27

Import

A GitLab User Impersonation Token can be imported using a key composed of <user-id>:<token-id>, e.g.

$ pulumi import gitlab:index/userImpersonationToken:UserImpersonationToken example "12345:1"

NOTE: the token resource attribute is not available for imported resources as this information cannot be read from the GitLab API.

Constructors

UserImpersonationTokenArgs

constructor(expiresAt: Output<String>? = null, name: Output<String>? = null, scopes: Output<List<String>>? = null, userId: Output<Int>? = null)

Properties

expiresAt

val expiresAt: Output<String>? = null

Expiration date of the impersonation token in ISO format (YYYY-MM-DD).

name

val name: Output<String>? = null

The name of the impersonation token.

scopes

val scopes: Output<List<String>>? = null

Array of scopes of the impersonation token. valid values are: api, read_user, read_api, read_repository, write_repository, read_registry, write_registry, sudo, admin_mode, create_runner, manage_runner, ai_features, k8s_proxy, read_service_ping

userId

val userId: Output<Int>? = null

The ID of the user.

Functions

toJava

open override fun toJava(): UserImpersonationTokenArgs