1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. getUser
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Permission.getUser

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski

Retrieves information about a specific user.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@pulumi/proxmoxve";

const operationsUser = proxmoxve.Permission.getUser({
    userId: "operation@pam",
});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

operations_user = proxmoxve.Permission.get_user(user_id="operation@pam")
Copy
package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/permission"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := permission.GetUser(ctx, &permission.GetUserArgs{
			UserId: "operation@pam",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var operationsUser = ProxmoxVE.Permission.GetUser.Invoke(new()
    {
        UserId = "operation@pam",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Permission.PermissionFunctions;
import com.pulumi.proxmoxve.Permission.inputs.GetUserArgs;
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 operationsUser = PermissionFunctions.getUser(GetUserArgs.builder()
            .userId("operation@pam")
            .build());

    }
}
Copy
variables:
  operationsUser:
    fn::invoke:
      function: proxmoxve:Permission:getUser
      arguments:
        userId: operation@pam
Copy

Using getUser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
Copy
def get_user(user_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(user_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
Copy
func GetUser(ctx *Context, args *GetUserArgs, opts ...InvokeOption) (*GetUserResult, error)
func GetUserOutput(ctx *Context, args *GetUserOutputArgs, opts ...InvokeOption) GetUserResultOutput
Copy

> Note: This function is named GetUser in the Go SDK.

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Permission/getUser:getUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

UserId This property is required. string
The user identifier.
UserId This property is required. string
The user identifier.
userId This property is required. String
The user identifier.
userId This property is required. string
The user identifier.
user_id This property is required. str
The user identifier.
userId This property is required. String
The user identifier.

getUser Result

The following output properties are available:

Acls List<Pulumi.ProxmoxVE.Permission.Outputs.GetUserAcl>
The access control list.
Comment string
The user comment.
Email string
The user's email address.
Enabled bool
Whether the user account is enabled.
ExpirationDate string
The user account's expiration date (RFC 3339).
FirstName string
The user's first name.
Groups List<string>
The user's groups.
Id string
The provider-assigned unique ID for this managed resource.
Keys string
The user's keys.
LastName string
The user's last name.
UserId string
Acls []GetUserAcl
The access control list.
Comment string
The user comment.
Email string
The user's email address.
Enabled bool
Whether the user account is enabled.
ExpirationDate string
The user account's expiration date (RFC 3339).
FirstName string
The user's first name.
Groups []string
The user's groups.
Id string
The provider-assigned unique ID for this managed resource.
Keys string
The user's keys.
LastName string
The user's last name.
UserId string
acls List<GetUserAcl>
The access control list.
comment String
The user comment.
email String
The user's email address.
enabled Boolean
Whether the user account is enabled.
expirationDate String
The user account's expiration date (RFC 3339).
firstName String
The user's first name.
groups List<String>
The user's groups.
id String
The provider-assigned unique ID for this managed resource.
keys String
The user's keys.
lastName String
The user's last name.
userId String
acls GetUserAcl[]
The access control list.
comment string
The user comment.
email string
The user's email address.
enabled boolean
Whether the user account is enabled.
expirationDate string
The user account's expiration date (RFC 3339).
firstName string
The user's first name.
groups string[]
The user's groups.
id string
The provider-assigned unique ID for this managed resource.
keys string
The user's keys.
lastName string
The user's last name.
userId string
acls Sequence[permission.GetUserAcl]
The access control list.
comment str
The user comment.
email str
The user's email address.
enabled bool
Whether the user account is enabled.
expiration_date str
The user account's expiration date (RFC 3339).
first_name str
The user's first name.
groups Sequence[str]
The user's groups.
id str
The provider-assigned unique ID for this managed resource.
keys str
The user's keys.
last_name str
The user's last name.
user_id str
acls List<Property Map>
The access control list.
comment String
The user comment.
email String
The user's email address.
enabled Boolean
Whether the user account is enabled.
expirationDate String
The user account's expiration date (RFC 3339).
firstName String
The user's first name.
groups List<String>
The user's groups.
id String
The provider-assigned unique ID for this managed resource.
keys String
The user's keys.
lastName String
The user's last name.
userId String

Supporting Types

GetUserAcl

Path This property is required. string
The path.
Propagate This property is required. bool
Whether to propagate to child paths.
RoleId This property is required. string
The role identifier.
Path This property is required. string
The path.
Propagate This property is required. bool
Whether to propagate to child paths.
RoleId This property is required. string
The role identifier.
path This property is required. String
The path.
propagate This property is required. Boolean
Whether to propagate to child paths.
roleId This property is required. String
The role identifier.
path This property is required. string
The path.
propagate This property is required. boolean
Whether to propagate to child paths.
roleId This property is required. string
The role identifier.
path This property is required. str
The path.
propagate This property is required. bool
Whether to propagate to child paths.
role_id This property is required. str
The role identifier.
path This property is required. String
The path.
propagate This property is required. Boolean
Whether to propagate to child paths.
roleId This property is required. String
The role identifier.

Package Details

Repository
proxmoxve muhlba91/pulumi-proxmoxve
License
Apache-2.0
Notes
This Pulumi package is based on the proxmox Terraform Provider.
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski