UserGpgKeyArgs

data class UserGpgKeyArgs(val key: Output<String>? = null, val userId: Output<Int>? = null) : ConvertibleToJava<UserGpgKeyArgs>

The gitlab.UserGpgKey resource allows to manage the lifecycle of a GPG key assigned to the current user or a specific user.

Managing GPG keys for arbitrary users requires admin privileges. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = gitlab.getUser({
username: "example-user",
});
// Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
const exampleUserGpgKey = new gitlab.UserGpgKey("example", {
userId: example.then(example => example.id),
key: `-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----`,
});
// Manages a GPG key for the current user
const exampleUser = new gitlab.UserGpgKey("example_user", {key: `-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----`});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.get_user(username="example-user")
# Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
example_user_gpg_key = gitlab.UserGpgKey("example",
user_id=example.id,
key="""-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----""")
# Manages a GPG key for the current user
example_user = gitlab.UserGpgKey("example_user", key="""-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = GitLab.GetUser.Invoke(new()
{
Username = "example-user",
});
// Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
var exampleUserGpgKey = new GitLab.UserGpgKey("example", new()
{
UserId = example.Apply(getUserResult => getUserResult.Id),
Key = @"-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----",
});
// Manages a GPG key for the current user
var exampleUser = new GitLab.UserGpgKey("example_user", new()
{
Key = @"-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----",
});
});
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 {
example, err := gitlab.LookupUser(ctx, &gitlab.LookupUserArgs{
Username: pulumi.StringRef("example-user"),
}, nil)
if err != nil {
return err
}
// Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
_, err = gitlab.NewUserGpgKey(ctx, "example", &gitlab.UserGpgKeyArgs{
UserId: pulumi.String(example.Id),
Key: pulumi.String("-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----"),
})
if err != nil {
return err
}
// Manages a GPG key for the current user
_, err = gitlab.NewUserGpgKey(ctx, "example_user", &gitlab.UserGpgKeyArgs{
Key: pulumi.String("-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----"),
})
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.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetUserArgs;
import com.pulumi.gitlab.UserGpgKey;
import com.pulumi.gitlab.UserGpgKeyArgs;
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) {
final var example = GitlabFunctions.getUser(GetUserArgs.builder()
.username("example-user")
.build());
// Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
var exampleUserGpgKey = new UserGpgKey("exampleUserGpgKey", UserGpgKeyArgs.builder()
.userId(example.applyValue(getUserResult -> getUserResult.id()))
.key("""
-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK----- """)
.build());
// Manages a GPG key for the current user
var exampleUser = new UserGpgKey("exampleUser", UserGpgKeyArgs.builder()
.key("""
-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK----- """)
.build());
}
}
resources:
# Manages a GPG key for the specified user. An admin token is required if `user_id` is specified.
exampleUserGpgKey:
type: gitlab:UserGpgKey
name: example
properties:
userId: ${example.id}
key: |-
-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----
# Manages a GPG key for the current user
exampleUser:
type: gitlab:UserGpgKey
name: example_user
properties:
key: |-
-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----
variables:
example:
fn::invoke:
function: gitlab:getUser
arguments:
username: example-user

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_user_gpgkey. For example: terraform import { to = gitlab_user_gpgkey.example id = "see CLI command below for ID" } Import using the CLI is supported using the following syntax: You can import a GPG key for a specific user using an id made up of {user-id}:{key}, e.g.

$ pulumi import gitlab:index/userGpgKey:UserGpgKey example 42:1

Alternatively, you can import a GPG key for the current user using an id made up of {key}, e.g.

$ pulumi import gitlab:index/userGpgKey:UserGpgKey example_user 1

Constructors

Link copied to clipboard
constructor(key: Output<String>? = null, userId: Output<Int>? = null)

Properties

Link copied to clipboard
val key: Output<String>? = null

The armored GPG public key.

Link copied to clipboard
val userId: Output<Int>? = null

The ID of the user to add the GPG key to. If this field is omitted, this resource manages a GPG key for the current user. Otherwise, this resource manages a GPG key for the specified user, and an admin token is required.

Functions

Link copied to clipboard
open override fun toJava(): UserGpgKeyArgs