User

Create a User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         can_create_group: Optional[bool] = None,
         email: Optional[str] = None,
         is_admin: Optional[bool] = None,
         is_external: Optional[bool] = None,
         name: Optional[str] = None,
         note: Optional[str] = None,
         password: Optional[str] = None,
         projects_limit: Optional[int] = None,
         reset_password: Optional[bool] = None,
         skip_confirmation: Optional[bool] = None,
         username: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The User resource accepts the following input properties:

Email string
The e-mail address of the user.
Username string
The username of the user.
CanCreateGroup bool
Boolean, defaults to false. Whether to allow the user to create groups.
IsAdmin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
IsExternal bool
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.
Name string
The name of the user.
Note string
The note associated to the user.
Password string
The password of the user.
ProjectsLimit int
Integer, defaults to 0. Number of projects user can create.
ResetPassword bool
Boolean, defaults to false. Send user password reset link.
SkipConfirmation bool
Boolean, defaults to true. Whether to skip confirmation.
Email string
The e-mail address of the user.
Username string
The username of the user.
CanCreateGroup bool
Boolean, defaults to false. Whether to allow the user to create groups.
IsAdmin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
IsExternal bool
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.
Name string
The name of the user.
Note string
The note associated to the user.
Password string
The password of the user.
ProjectsLimit int
Integer, defaults to 0. Number of projects user can create.
ResetPassword bool
Boolean, defaults to false. Send user password reset link.
SkipConfirmation bool
Boolean, defaults to true. Whether to skip confirmation.
email string
The e-mail address of the user.
username string
The username of the user.
canCreateGroup boolean
Boolean, defaults to false. Whether to allow the user to create groups.
isAdmin boolean
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
isExternal boolean
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.
name string
The name of the user.
note string
The note associated to the user.
password string
The password of the user.
projectsLimit number
Integer, defaults to 0. Number of projects user can create.
resetPassword boolean
Boolean, defaults to false. Send user password reset link.
skipConfirmation boolean
Boolean, defaults to true. Whether to skip confirmation.
email str
The e-mail address of the user.
username str
The username of the user.
can_create_group bool
Boolean, defaults to false. Whether to allow the user to create groups.
is_admin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
is_external bool
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.
name str
The name of the user.
note str
The note associated to the user.
password str
The password of the user.
projects_limit int
Integer, defaults to 0. Number of projects user can create.
reset_password bool
Boolean, defaults to false. Send user password reset link.
skip_confirmation bool
Boolean, defaults to true. Whether to skip confirmation.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_create_group: Optional[bool] = None,
        email: Optional[str] = None,
        is_admin: Optional[bool] = None,
        is_external: Optional[bool] = None,
        name: Optional[str] = None,
        note: Optional[str] = None,
        password: Optional[str] = None,
        projects_limit: Optional[int] = None,
        reset_password: Optional[bool] = None,
        skip_confirmation: Optional[bool] = None,
        username: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

CanCreateGroup bool
Boolean, defaults to false. Whether to allow the user to create groups.
Email string
The e-mail address of the user.
IsAdmin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
IsExternal bool
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.
Name string
The name of the user.
Note string
The note associated to the user.
Password string
The password of the user.
ProjectsLimit int
Integer, defaults to 0. Number of projects user can create.
ResetPassword bool
Boolean, defaults to false. Send user password reset link.
SkipConfirmation bool
Boolean, defaults to true. Whether to skip confirmation.
Username string
The username of the user.
CanCreateGroup bool
Boolean, defaults to false. Whether to allow the user to create groups.
Email string
The e-mail address of the user.
IsAdmin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
IsExternal bool
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.
Name string
The name of the user.
Note string
The note associated to the user.
Password string
The password of the user.
ProjectsLimit int
Integer, defaults to 0. Number of projects user can create.
ResetPassword bool
Boolean, defaults to false. Send user password reset link.
SkipConfirmation bool
Boolean, defaults to true. Whether to skip confirmation.
Username string
The username of the user.
canCreateGroup boolean
Boolean, defaults to false. Whether to allow the user to create groups.
email string
The e-mail address of the user.
isAdmin boolean
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
isExternal boolean
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.
name string
The name of the user.
note string
The note associated to the user.
password string
The password of the user.
projectsLimit number
Integer, defaults to 0. Number of projects user can create.
resetPassword boolean
Boolean, defaults to false. Send user password reset link.
skipConfirmation boolean
Boolean, defaults to true. Whether to skip confirmation.
username string
The username of the user.
can_create_group bool
Boolean, defaults to false. Whether to allow the user to create groups.
email str
The e-mail address of the user.
is_admin bool
Boolean, defaults to false. Whether to enable administrative priviledges for the user.
is_external bool
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.
name str
The name of the user.
note str
The note associated to the user.
password str
The password of the user.
projects_limit int
Integer, defaults to 0. Number of projects user can create.
reset_password bool
Boolean, defaults to false. Send user password reset link.
skip_confirmation bool
Boolean, defaults to true. Whether to skip confirmation.
username str
The username of the user.

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.