1. Packages
  2. Zitadel
  3. API Docs
  4. getHumanUser
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

zitadel.getHumanUser

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

    Datasource representing a human user situated under an organization, which then can be authorized through memberships or direct grants on other resources.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumi.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Zitadel.GetHumanUser.Invoke(new()
        {
            OrgId = data.Zitadel_org.Default.Id,
            UserId = "123456789012345678",
        });
    
        return new Dictionary<string, object?>
        {
            ["humanUser"] = @default,
        };
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_default, err := zitadel.LookupHumanUser(ctx, &zitadel.LookupHumanUserArgs{
    			OrgId:  data.Zitadel_org.Default.Id,
    			UserId: "123456789012345678",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("humanUser", _default)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.ZitadelFunctions;
    import com.pulumi.zitadel.inputs.GetHumanUserArgs;
    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 default = ZitadelFunctions.getHumanUser(GetHumanUserArgs.builder()
                .orgId(data.zitadel_org().default().id())
                .userId("123456789012345678")
                .build());
    
            ctx.export("humanUser", default_);
        }
    }
    
    import pulumi
    import pulumi_zitadel as zitadel
    
    default = zitadel.get_human_user(org_id=data["zitadel_org"]["default"]["id"],
        user_id="123456789012345678")
    pulumi.export("humanUser", default)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumi/zitadel";
    
    const default = zitadel.getHumanUser({
        orgId: data.zitadel_org["default"].id,
        userId: "123456789012345678",
    });
    export const humanUser = _default;
    
    variables:
      default:
        fn::invoke:
          Function: zitadel:getHumanUser
          Arguments:
            orgId: ${data.zitadel_org.default.id}
            userId: '123456789012345678'
    outputs:
      humanUser: ${default}
    

    Using getHumanUser

    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 getHumanUser(args: GetHumanUserArgs, opts?: InvokeOptions): Promise<GetHumanUserResult>
    function getHumanUserOutput(args: GetHumanUserOutputArgs, opts?: InvokeOptions): Output<GetHumanUserResult>
    def get_human_user(org_id: Optional[str] = None,
                       user_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetHumanUserResult
    def get_human_user_output(org_id: Optional[pulumi.Input[str]] = None,
                       user_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetHumanUserResult]
    func LookupHumanUser(ctx *Context, args *LookupHumanUserArgs, opts ...InvokeOption) (*LookupHumanUserResult, error)
    func LookupHumanUserOutput(ctx *Context, args *LookupHumanUserOutputArgs, opts ...InvokeOption) LookupHumanUserResultOutput

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

    public static class GetHumanUser 
    {
        public static Task<GetHumanUserResult> InvokeAsync(GetHumanUserArgs args, InvokeOptions? opts = null)
        public static Output<GetHumanUserResult> Invoke(GetHumanUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHumanUserResult> getHumanUser(GetHumanUserArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: zitadel:index/getHumanUser:getHumanUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrgId string
    ID of the organization
    UserId string
    The ID of this resource.
    OrgId string
    ID of the organization
    UserId string
    The ID of this resource.
    orgId String
    ID of the organization
    userId String
    The ID of this resource.
    orgId string
    ID of the organization
    userId string
    The ID of this resource.
    org_id str
    ID of the organization
    user_id str
    The ID of this resource.
    orgId String
    ID of the organization
    userId String
    The ID of this resource.

    getHumanUser Result

    The following output properties are available:

    DisplayName string
    Display name of the user
    Email string
    Email of the user
    FirstName string
    First name of the user
    Gender string
    Gender of the user
    Id string
    The provider-assigned unique ID for this managed resource.
    IsEmailVerified bool
    Is the email verified of the user, can only be true if password of the user is set
    IsPhoneVerified bool
    Is the phone verified of the user
    LastName string
    Last name of the user
    LoginNames List<string>
    Loginnames
    NickName string
    Nick name of the user
    OrgId string
    ID of the organization
    Phone string
    Phone of the user
    PreferredLanguage string
    Preferred language of the user
    PreferredLoginName string
    Preferred login name
    State string
    State of the user
    UserId string
    The ID of this resource.
    UserName string
    Username
    DisplayName string
    Display name of the user
    Email string
    Email of the user
    FirstName string
    First name of the user
    Gender string
    Gender of the user
    Id string
    The provider-assigned unique ID for this managed resource.
    IsEmailVerified bool
    Is the email verified of the user, can only be true if password of the user is set
    IsPhoneVerified bool
    Is the phone verified of the user
    LastName string
    Last name of the user
    LoginNames []string
    Loginnames
    NickName string
    Nick name of the user
    OrgId string
    ID of the organization
    Phone string
    Phone of the user
    PreferredLanguage string
    Preferred language of the user
    PreferredLoginName string
    Preferred login name
    State string
    State of the user
    UserId string
    The ID of this resource.
    UserName string
    Username
    displayName String
    Display name of the user
    email String
    Email of the user
    firstName String
    First name of the user
    gender String
    Gender of the user
    id String
    The provider-assigned unique ID for this managed resource.
    isEmailVerified Boolean
    Is the email verified of the user, can only be true if password of the user is set
    isPhoneVerified Boolean
    Is the phone verified of the user
    lastName String
    Last name of the user
    loginNames List<String>
    Loginnames
    nickName String
    Nick name of the user
    orgId String
    ID of the organization
    phone String
    Phone of the user
    preferredLanguage String
    Preferred language of the user
    preferredLoginName String
    Preferred login name
    state String
    State of the user
    userId String
    The ID of this resource.
    userName String
    Username
    displayName string
    Display name of the user
    email string
    Email of the user
    firstName string
    First name of the user
    gender string
    Gender of the user
    id string
    The provider-assigned unique ID for this managed resource.
    isEmailVerified boolean
    Is the email verified of the user, can only be true if password of the user is set
    isPhoneVerified boolean
    Is the phone verified of the user
    lastName string
    Last name of the user
    loginNames string[]
    Loginnames
    nickName string
    Nick name of the user
    orgId string
    ID of the organization
    phone string
    Phone of the user
    preferredLanguage string
    Preferred language of the user
    preferredLoginName string
    Preferred login name
    state string
    State of the user
    userId string
    The ID of this resource.
    userName string
    Username
    display_name str
    Display name of the user
    email str
    Email of the user
    first_name str
    First name of the user
    gender str
    Gender of the user
    id str
    The provider-assigned unique ID for this managed resource.
    is_email_verified bool
    Is the email verified of the user, can only be true if password of the user is set
    is_phone_verified bool
    Is the phone verified of the user
    last_name str
    Last name of the user
    login_names Sequence[str]
    Loginnames
    nick_name str
    Nick name of the user
    org_id str
    ID of the organization
    phone str
    Phone of the user
    preferred_language str
    Preferred language of the user
    preferred_login_name str
    Preferred login name
    state str
    State of the user
    user_id str
    The ID of this resource.
    user_name str
    Username
    displayName String
    Display name of the user
    email String
    Email of the user
    firstName String
    First name of the user
    gender String
    Gender of the user
    id String
    The provider-assigned unique ID for this managed resource.
    isEmailVerified Boolean
    Is the email verified of the user, can only be true if password of the user is set
    isPhoneVerified Boolean
    Is the phone verified of the user
    lastName String
    Last name of the user
    loginNames List<String>
    Loginnames
    nickName String
    Nick name of the user
    orgId String
    ID of the organization
    phone String
    Phone of the user
    preferredLanguage String
    Preferred language of the user
    preferredLoginName String
    Preferred login name
    state String
    State of the user
    userId String
    The ID of this resource.
    userName String
    Username

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse