pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/UserArgs

UserArgs

data class UserArgs(val canCreateGroup: Output<Boolean>? = null, val email: Output<String>? = null, val externUid: Output<String>? = null, val externalProvider: Output<String>? = null, val forceRandomPassword: Output<Boolean>? = null, val isAdmin: Output<Boolean>? = null, val isExternal: Output<Boolean>? = null, val name: Output<String>? = null, val namespaceId: Output<Int>? = null, val note: Output<String>? = null, val password: Output<String>? = null, val projectsLimit: Output<Int>? = null, val resetPassword: Output<Boolean>? = null, val skipConfirmation: Output<Boolean>? = null, val state: Output<String>? = null, val username: Output<String>? = null) : ConvertibleToJava<UserArgs>

The gitlab.User resource allows to manage the lifecycle of a user.

the provider needs to be configured with admin-level access for this resource to work. You must specify either password or reset_password. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.User("example", {
    name: "Example Foo",
    username: "example",
    password: "superPassword",
    email: "gitlab@user.create",
    isAdmin: true,
    projectsLimit: 4,
    canCreateGroup: false,
    isExternal: true,
    resetPassword: false,
});
Content copied to clipboard
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.User("example",
    name="Example Foo",
    username="example",
    password="superPassword",
    email="gitlab@user.create",
    is_admin=True,
    projects_limit=4,
    can_create_group=False,
    is_external=True,
    reset_password=False)
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.User("example", new()
    {
        Name = "Example Foo",
        Username = "example",
        Password = "superPassword",
        Email = "gitlab@user.create",
        IsAdmin = true,
        ProjectsLimit = 4,
        CanCreateGroup = false,
        IsExternal = true,
        ResetPassword = false,
    });
});
Content copied to clipboard
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.NewUser(ctx, "example", &gitlab.UserArgs{
			Name:           pulumi.String("Example Foo"),
			Username:       pulumi.String("example"),
			Password:       pulumi.String("superPassword"),
			Email:          pulumi.String("gitlab@user.create"),
			IsAdmin:        pulumi.Bool(true),
			ProjectsLimit:  pulumi.Int(4),
			CanCreateGroup: pulumi.Bool(false),
			IsExternal:     pulumi.Bool(true),
			ResetPassword:  pulumi.Bool(false),
		})
		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.User;
import com.pulumi.gitlab.UserArgs;
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 User("example", UserArgs.builder()
            .name("Example Foo")
            .username("example")
            .password("superPassword")
            .email("gitlab@user.create")
            .isAdmin(true)
            .projectsLimit(4)
            .canCreateGroup(false)
            .isExternal(true)
            .resetPassword(false)
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: gitlab:User
    properties:
      name: Example Foo
      username: example
      password: superPassword
      email: gitlab@user.create
      isAdmin: true
      projectsLimit: 4
      canCreateGroup: false
      isExternal: true
      resetPassword: false
Content copied to clipboard

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_user. For example: terraform import { to = gitlab_user.example id = "see CLI command below for ID" } Import using the CLI is supported using the following syntax:

$ pulumi import gitlab:index/user:User You can import a user to terraform state using `<resource> <id>`.
Content copied to clipboard

The id must be an integer for the id of the user you want to import, for example:

$ pulumi import gitlab:index/user:User example 42
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(canCreateGroup: Output<Boolean>? = null, email: Output<String>? = null, externUid: Output<String>? = null, externalProvider: Output<String>? = null, forceRandomPassword: Output<Boolean>? = null, isAdmin: Output<Boolean>? = null, isExternal: Output<Boolean>? = null, name: Output<String>? = null, namespaceId: Output<Int>? = null, note: Output<String>? = null, password: Output<String>? = null, projectsLimit: Output<Int>? = null, resetPassword: Output<Boolean>? = null, skipConfirmation: Output<Boolean>? = null, state: Output<String>? = null, username: Output<String>? = null)

Properties

Link copied to clipboard
val canCreateGroup: Output<Boolean>? = null

Boolean, defaults to false. Whether to allow the user to create groups.

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

The e-mail address of the user.

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

String, the external provider.

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

String, a specific external authentication provider UID.

Link copied to clipboard
val forceRandomPassword: Output<Boolean>? = null

Set user password to a random value

Link copied to clipboard
val isAdmin: Output<Boolean>? = null

Boolean, defaults to false. Whether to enable administrative privileges

Link copied to clipboard
val isExternal: Output<Boolean>? = null

Boolean, defaults to false. Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access.

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

The name of the user.

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

The ID of the user's namespace.

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

The note associated to the user.

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

The password of the user.

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

Integer, defaults to 0. Number of projects user can create.

Link copied to clipboard
val resetPassword: Output<Boolean>? = null

Boolean, defaults to false. Send user password reset link.

Link copied to clipboard
val skipConfirmation: Output<Boolean>? = null

Boolean, defaults to true. Whether to skip confirmation.

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

String, defaults to 'active'. The state of the user account. Valid values are active, deactivated, blocked.

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

The username of the user.

Functions

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