Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aquasec
  3. API Docs
  4. User
Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
pulumiverse/pulumi-aquasec

aquasec.User

Explore with Pulumi AI

aquasec logo
Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
pulumiverse/pulumi-aquasec

    The aquasec.User resource manages your users within Aqua.

    The users created must have at least one Role that is already present within Aqua.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aquasec from "@pulumiverse/aquasec";

const iaC = new aquasec.User("iaC", {
    userId: "IaC",
    password: _var.password,
    roles: ["infrastructure"],
    email: "infrastructure@example.com",
    firstTime: true,
});
// Display name for this user

    import pulumi
import pulumiverse_aquasec as aquasec

ia_c = aquasec.User("iaC",
    user_id="IaC",
    password=var["password"],
    roles=["infrastructure"],
    email="infrastructure@example.com",
    first_time=True)
# Display name for this user

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-aquasec/sdk/go/aquasec"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aquasec.NewUser(ctx, "iaC", &aquasec.UserArgs{
			UserId:   pulumi.String("IaC"),
			Password: pulumi.Any(_var.Password),
			Roles: pulumi.StringArray{
				pulumi.String("infrastructure"),
			},
			Email:     pulumi.String("infrastructure@example.com"),
			FirstTime: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aquasec = Pulumiverse.Aquasec;

return await Deployment.RunAsync(() => 
{
    var iaC = new Aquasec.User("iaC", new()
    {
        UserId = "IaC",
        Password = @var.Password,
        Roles = new[]
        {
            "infrastructure",
        },
        Email = "infrastructure@example.com",
        FirstTime = true,
    });

    // Display name for this user
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aquasec.User;
import com.pulumi.aquasec.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 iaC = new User("iaC", UserArgs.builder()
            .userId("IaC")
            .password(var_.password())
            .roles("infrastructure")
            .email("infrastructure@example.com")
            .firstTime(true)
            .build());

        // Display name for this user
    }
}

    resources:
  iaC:
    type: aquasec:User
    properties:
      userId: IaC
      password: ${var.password}
      roles:
        - infrastructure
      # optional fields
      email: infrastructure@example.com
      firstTime: true

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         password: Optional[str] = None,
         roles: Optional[Sequence[str]] = None,
         user_id: Optional[str] = None,
         email: Optional[str] = None,
         first_time: Optional[bool] = None,
         name: Optional[str] = None,
         password_confirm: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: aquasec:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Aquasec.User("userResource", new()
{
    Password = "string",
    Roles = new[]
    {
        "string",
    },
    UserId = "string",
    Email = "string",
    FirstTime = false,
    Name = "string",
    PasswordConfirm = "string",
});

    example, err := aquasec.NewUser(ctx, "userResource", &aquasec.UserArgs{
	Password: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserId:          pulumi.String("string"),
	Email:           pulumi.String("string"),
	FirstTime:       pulumi.Bool(false),
	Name:            pulumi.String("string"),
	PasswordConfirm: pulumi.String("string"),
})

    var userResource = new User("userResource", UserArgs.builder()
    .password("string")
    .roles("string")
    .userId("string")
    .email("string")
    .firstTime(false)
    .name("string")
    .passwordConfirm("string")
    .build());

    user_resource = aquasec.User("userResource",
    password="string",
    roles=["string"],
    user_id="string",
    email="string",
    first_time=False,
    name="string",
    password_confirm="string")

    const userResource = new aquasec.User("userResource", {
    password: "string",
    roles: ["string"],
    userId: "string",
    email: "string",
    firstTime: false,
    name: "string",
    passwordConfirm: "string",
});

    type: aquasec:User
properties:
    email: string
    firstTime: false
    name: string
    password: string
    passwordConfirm: string
    roles:
        - string
    userId: string

    User Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Password string
    Login password for the user; string, required, at least 8 characters long.
    Roles List<string>
    The roles that will be assigned to the user.
    UserId string
    The user ID.
    Email string
    The user Email.
    FirstTime bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    Name string
    The user name.
    PasswordConfirm string
    Password confirmation.
    Password string
    Login password for the user; string, required, at least 8 characters long.
    Roles []string
    The roles that will be assigned to the user.
    UserId string
    The user ID.
    Email string
    The user Email.
    FirstTime bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    Name string
    The user name.
    PasswordConfirm string
    Password confirmation.
    password String
    Login password for the user; string, required, at least 8 characters long.
    roles List<String>
    The roles that will be assigned to the user.
    userId String
    The user ID.
    email String
    The user Email.
    firstTime Boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    name String
    The user name.
    passwordConfirm String
    Password confirmation.
    password string
    Login password for the user; string, required, at least 8 characters long.
    roles string[]
    The roles that will be assigned to the user.
    userId string
    The user ID.
    email string
    The user Email.
    firstTime boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    name string
    The user name.
    passwordConfirm string
    Password confirmation.
    password str
    Login password for the user; string, required, at least 8 characters long.
    roles Sequence[str]
    The roles that will be assigned to the user.
    user_id str
    The user ID.
    email str
    The user Email.
    first_time bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    name str
    The user name.
    password_confirm str
    Password confirmation.
    password String
    Login password for the user; string, required, at least 8 characters long.
    roles List<String>
    The roles that will be assigned to the user.
    userId String
    The user ID.
    email String
    The user Email.
    firstTime Boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    name String
    The user name.
    passwordConfirm String
    Password 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.
    IsSuper bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    Plan string
    User's Aqua plan (Developer / Team / Advanced).
    Role string
    The first role that assigned to the user for backward compatibility.
    Type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    UiAccess bool
    Whether to allow UI access for users with this Permission Set.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSuper bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    Plan string
    User's Aqua plan (Developer / Team / Advanced).
    Role string
    The first role that assigned to the user for backward compatibility.
    Type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    UiAccess bool
    Whether to allow UI access for users with this Permission Set.
    id String
    The provider-assigned unique ID for this managed resource.
    isSuper Boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    plan String
    User's Aqua plan (Developer / Team / Advanced).
    role String
    The first role that assigned to the user for backward compatibility.
    type String
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess Boolean
    Whether to allow UI access for users with this Permission Set.
    id string
    The provider-assigned unique ID for this managed resource.
    isSuper boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    plan string
    User's Aqua plan (Developer / Team / Advanced).
    role string
    The first role that assigned to the user for backward compatibility.
    type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess boolean
    Whether to allow UI access for users with this Permission Set.
    id str
    The provider-assigned unique ID for this managed resource.
    is_super bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    plan str
    User's Aqua plan (Developer / Team / Advanced).
    role str
    The first role that assigned to the user for backward compatibility.
    type str
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    ui_access bool
    Whether to allow UI access for users with this Permission Set.
    id String
    The provider-assigned unique ID for this managed resource.
    isSuper Boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    plan String
    User's Aqua plan (Developer / Team / Advanced).
    role String
    The first role that assigned to the user for backward compatibility.
    type String
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess Boolean
    Whether to allow UI access for users with this Permission Set.

    Look up 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,
        email: Optional[str] = None,
        first_time: Optional[bool] = None,
        is_super: Optional[bool] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_confirm: Optional[str] = None,
        plan: Optional[str] = None,
        role: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        ui_access: Optional[bool] = None,
        user_id: 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)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    Email string
    The user Email.
    FirstTime bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    IsSuper bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    Name string
    The user name.
    Password string
    Login password for the user; string, required, at least 8 characters long.
    PasswordConfirm string
    Password confirmation.
    Plan string
    User's Aqua plan (Developer / Team / Advanced).
    Role string
    The first role that assigned to the user for backward compatibility.
    Roles List<string>
    The roles that will be assigned to the user.
    Type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    UiAccess bool
    Whether to allow UI access for users with this Permission Set.
    UserId string
    The user ID.
    Email string
    The user Email.
    FirstTime bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    IsSuper bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    Name string
    The user name.
    Password string
    Login password for the user; string, required, at least 8 characters long.
    PasswordConfirm string
    Password confirmation.
    Plan string
    User's Aqua plan (Developer / Team / Advanced).
    Role string
    The first role that assigned to the user for backward compatibility.
    Roles []string
    The roles that will be assigned to the user.
    Type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    UiAccess bool
    Whether to allow UI access for users with this Permission Set.
    UserId string
    The user ID.
    email String
    The user Email.
    firstTime Boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    isSuper Boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    name String
    The user name.
    password String
    Login password for the user; string, required, at least 8 characters long.
    passwordConfirm String
    Password confirmation.
    plan String
    User's Aqua plan (Developer / Team / Advanced).
    role String
    The first role that assigned to the user for backward compatibility.
    roles List<String>
    The roles that will be assigned to the user.
    type String
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess Boolean
    Whether to allow UI access for users with this Permission Set.
    userId String
    The user ID.
    email string
    The user Email.
    firstTime boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    isSuper boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    name string
    The user name.
    password string
    Login password for the user; string, required, at least 8 characters long.
    passwordConfirm string
    Password confirmation.
    plan string
    User's Aqua plan (Developer / Team / Advanced).
    role string
    The first role that assigned to the user for backward compatibility.
    roles string[]
    The roles that will be assigned to the user.
    type string
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess boolean
    Whether to allow UI access for users with this Permission Set.
    userId string
    The user ID.
    email str
    The user Email.
    first_time bool
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    is_super bool
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    name str
    The user name.
    password str
    Login password for the user; string, required, at least 8 characters long.
    password_confirm str
    Password confirmation.
    plan str
    User's Aqua plan (Developer / Team / Advanced).
    role str
    The first role that assigned to the user for backward compatibility.
    roles Sequence[str]
    The roles that will be assigned to the user.
    type str
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    ui_access bool
    Whether to allow UI access for users with this Permission Set.
    user_id str
    The user ID.
    email String
    The user Email.
    firstTime Boolean
    If the user must change the password first login. Applicable only one time, Later for user password resets use aqua console.
    isSuper Boolean
    Give the Permission Set full access, meaning all actions are allowed without restriction.
    name String
    The user name.
    password String
    Login password for the user; string, required, at least 8 characters long.
    passwordConfirm String
    Password confirmation.
    plan String
    User's Aqua plan (Developer / Team / Advanced).
    role String
    The first role that assigned to the user for backward compatibility.
    roles List<String>
    The roles that will be assigned to the user.
    type String
    The user type (Aqua, LDAP, SAML, OAuth2, OpenID, Tenant Manager).
    uiAccess Boolean
    Whether to allow UI access for users with this Permission Set.
    userId String
    The user ID.

    Package Details

    Repository
    aquasec pulumiverse/pulumi-aquasec
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aquasec Terraform Provider.
    aquasec logo
    Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
    pulumiverse/pulumi-aquasec