1. Packages
  2. Xen Orchestra
  3. API Docs
  4. getXoaUser
Viewing docs for xenorchestra v2.4.0
published on Thursday, Feb 26, 2026 by Vates
Schema (JSON)
vatesfr/pulumi-xenorchestra

xenorchestra.getXoaUser

xenorchestra logo
Viewing docs for xenorchestra v2.4.0
published on Thursday, Feb 26, 2026 by Vates
Schema (JSON)
vatesfr/pulumi-xenorchestra

    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 "@vates/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/v2/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 getXoaUser

    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 getXoaUser(args: GetXoaUserArgs, opts?: InvokeOptions): Promise<GetXoaUserResult>
function getXoaUserOutput(args: GetXoaUserOutputArgs, opts?: InvokeOptions): Output<GetXoaUserResult>
    def get_xoa_user(search_in_session: Optional[bool] = None,
                 username: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetXoaUserResult
def get_xoa_user_output(search_in_session: Optional[pulumi.Input[bool]] = None,
                 username: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetXoaUserResult]
    func GetXoaUser(ctx *Context, args *GetXoaUserArgs, opts ...InvokeOption) (*GetXoaUserResult, error)
func GetXoaUserOutput(ctx *Context, args *GetXoaUserOutputArgs, opts ...InvokeOption) GetXoaUserResultOutput

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

    public static class GetXoaUser 
{
    public static Task<GetXoaUserResult> InvokeAsync(GetXoaUserArgs args, InvokeOptions? opts = null)
    public static Output<GetXoaUserResult> Invoke(GetXoaUserInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetXoaUserResult> getXoaUser(GetXoaUserArgs args, InvokeOptions options)
public static Output<GetXoaUserResult> getXoaUser(GetXoaUserArgs args, InvokeOptions options)

    fn::invoke:
  function: xenorchestra:index/getXoaUser:getXoaUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Username string
    The username of the XO user.
    SearchInSession bool
    A boolean which will search for the user in the current session (session.getUser Xen Orchestra RPC call). This allows a non admin user to look up their own user account.
    Username string
    The username of the XO user.
    SearchInSession bool
    A boolean which will search for the user in the current session (session.getUser Xen Orchestra RPC call). This allows a non admin user to look up their own user account.
    username String
    The username of the XO user.
    searchInSession Boolean
    A boolean which will search for the user in the current session (session.getUser Xen Orchestra RPC call). This allows a non admin user to look up their own user account.
    username string
    The username of the XO user.
    searchInSession boolean
    A boolean which will search for the user in the current session (session.getUser Xen 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_session bool
    A boolean which will search for the user in the current session (session.getUser Xen Orchestra RPC call). This allows a non admin user to look up their own user account.
    username String
    The username of the XO user.
    searchInSession Boolean
    A boolean which will search for the user in the current session (session.getUser Xen Orchestra RPC call). This allows a non admin user to look up their own user account.

    getXoaUser 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.
    SearchInSession bool
    A boolean which will search for the user in the current session (session.getUser Xen 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.
    SearchInSession bool
    A boolean which will search for the user in the current session (session.getUser Xen 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.
    searchInSession Boolean
    A boolean which will search for the user in the current session (session.getUser Xen 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.
    searchInSession boolean
    A boolean which will search for the user in the current session (session.getUser Xen 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_session bool
    A boolean which will search for the user in the current session (session.getUser Xen 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.
    searchInSession Boolean
    A boolean which will search for the user in the current session (session.getUser Xen 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 xenorchestra Terraform Provider.
    xenorchestra logo
    Viewing docs for xenorchestra v2.4.0
    published on Thursday, Feb 26, 2026 by Vates
    Schema (JSON)
    vatesfr/pulumi-xenorchestra
      Try Pulumi Cloud free. Your team will thank you.