xenorchestra v1.5.2 published on Monday, Mar 10, 2025 by Vates
xenorchestra.getUser
Explore with Pulumi AI
Deprecated: xenorchestra.index/getuser.getUser has been deprecated in favor of xenorchestra.index/getxoauser.getXoaUser
Provides information about a Xen Orchestra user. If the Xen Orchestra user account you are using is not an admin, see the search_in_session parameter.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as xenorchestra from "@pulumi/xenorchestra";
const user = xenorchestra.getXoaUser({
    username: "my-username",
});
import pulumi
import pulumi_xenorchestra as xenorchestra
user = xenorchestra.get_xoa_user(username="my-username")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/vatesfr/pulumi-xenorchestra/sdk/go/xenorchestra"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xenorchestra.GetXoaUser(ctx, &xenorchestra.GetXoaUserArgs{
			Username: "my-username",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Xenorchestra = Pulumi.Xenorchestra;
return await Deployment.RunAsync(() => 
{
    var user = Xenorchestra.GetXoaUser.Invoke(new()
    {
        Username = "my-username",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.xenorchestra.XenorchestraFunctions;
import com.pulumi.xenorchestra.inputs.GetXoaUserArgs;
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 user = XenorchestraFunctions.getXoaUser(GetXoaUserArgs.builder()
            .username("my-username")
            .build());
    }
}
variables:
  user:
    fn::invoke:
      function: xenorchestra:getXoaUser
      arguments:
        username: my-username
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>def get_user(search_in_session: Optional[bool] = None,
             username: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(search_in_session: Optional[pulumi.Input[bool]] = None,
             username: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]func GetUser(ctx *Context, args *GetUserArgs, opts ...InvokeOption) (*GetUserResult, error)
func GetUserOutput(ctx *Context, args *GetUserOutputArgs, opts ...InvokeOption) GetUserResultOutput> 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)
}public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
fn::invoke:
  function: xenorchestra:index/getUser:getUser
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Username string
 - The username of the XO user.
 - Search
In boolSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- Username string
 - The username of the XO user.
 - Search
In boolSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- username String
 - The username of the XO user.
 - search
In BooleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- username string
 - The username of the XO user.
 - search
In booleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- username str
 - The username of the XO user.
 - search_
in_ boolsession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- username String
 - The username of the XO user.
 - search
In BooleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
getUser Result
The following output properties are available:
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Username string
 - The username of the XO user.
 - Search
In boolSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Username string
 - The username of the XO user.
 - Search
In boolSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- id String
 - The provider-assigned unique ID for this managed resource.
 - username String
 - The username of the XO user.
 - search
In BooleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- id string
 - The provider-assigned unique ID for this managed resource.
 - username string
 - The username of the XO user.
 - search
In booleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- id str
 - The provider-assigned unique ID for this managed resource.
 - username str
 - The username of the XO user.
 - search_
in_ boolsession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
- id String
 - The provider-assigned unique ID for this managed resource.
 - username String
 - The username of the XO user.
 - search
In BooleanSession  - A boolean which will search for the user in the current session (
session.getUserXen Orchestra RPC call). This allows a non admin user to look up their own user account. 
Package Details
- Repository
 - xenorchestra vatesfr/pulumi-xenorchestra
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
xenorchestraTerraform Provider.