Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getUser
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.getUser

Explore with Pulumi AI

auth0 logo
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

    Data source to retrieve a specific Auth0 user by user_id.

    Example Usage

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

// An Auth0 User loaded using its ID.
const myUser = auth0.getUser({
    userId: "auth0|34fdr23fdsfdfsf",
});

    import pulumi
import pulumi_auth0 as auth0

# An Auth0 User loaded using its ID.
my_user = auth0.get_user(user_id="auth0|34fdr23fdsfdfsf")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// An Auth0 User loaded using its ID.
		_, err := auth0.LookupUser(ctx, &auth0.LookupUserArgs{
			UserId: "auth0|34fdr23fdsfdfsf",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    // An Auth0 User loaded using its ID.
    var myUser = Auth0.GetUser.Invoke(new()
    {
        UserId = "auth0|34fdr23fdsfdfsf",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Auth0Functions;
import com.pulumi.auth0.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) {
        // An Auth0 User loaded using its ID.
        final var myUser = Auth0Functions.getUser(GetUserArgs.builder()
            .userId("auth0|34fdr23fdsfdfsf")
            .build());

    }
}

    variables:
  # An Auth0 User loaded using its ID.
  myUser:
    fn::invoke:
      Function: auth0:getUser
      Arguments:
        userId: auth0|34fdr23fdsfdfsf

    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(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]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

    > Note: This function is named LookupUser 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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: auth0:index/getUser:getUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    UserId string
    ID of the user.
    UserId string
    ID of the user.
    userId String
    ID of the user.
    userId string
    ID of the user.
    user_id str
    ID of the user.
    userId String
    ID of the user.

    getUser Result

    The following output properties are available:

    AppMetadata string
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    Blocked bool
    Indicates whether the user is blocked or not.
    ConnectionName string
    Name of the connection from which the user information was sourced.
    Email string
    Email address of the user.
    EmailVerified bool
    Indicates whether the email address has been verified.
    FamilyName string
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    GivenName string
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Nickname string
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Password string
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    Permissions List<GetUserPermission>
    List of API permissions granted to the user.
    PhoneNumber string
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    PhoneVerified bool
    Indicates whether the phone number has been verified.
    Picture string
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Roles List<string>
    Set of IDs of roles assigned to the user.
    UserId string
    ID of the user.
    UserMetadata string
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    Username string
    Username of the user. Only valid if the connection requires a username.
    VerifyEmail bool
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
    AppMetadata string
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    Blocked bool
    Indicates whether the user is blocked or not.
    ConnectionName string
    Name of the connection from which the user information was sourced.
    Email string
    Email address of the user.
    EmailVerified bool
    Indicates whether the email address has been verified.
    FamilyName string
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    GivenName string
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Nickname string
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Password string
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    Permissions []GetUserPermissionType
    List of API permissions granted to the user.
    PhoneNumber string
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    PhoneVerified bool
    Indicates whether the phone number has been verified.
    Picture string
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    Roles []string
    Set of IDs of roles assigned to the user.
    UserId string
    ID of the user.
    UserMetadata string
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    Username string
    Username of the user. Only valid if the connection requires a username.
    VerifyEmail bool
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
    appMetadata String
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    blocked Boolean
    Indicates whether the user is blocked or not.
    connectionName String
    Name of the connection from which the user information was sourced.
    email String
    Email address of the user.
    emailVerified Boolean
    Indicates whether the email address has been verified.
    familyName String
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    givenName String
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    nickname String
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    password String
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    permissions List<GetUserPermission>
    List of API permissions granted to the user.
    phoneNumber String
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    phoneVerified Boolean
    Indicates whether the phone number has been verified.
    picture String
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    roles List<String>
    Set of IDs of roles assigned to the user.
    userId String
    ID of the user.
    userMetadata String
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    username String
    Username of the user. Only valid if the connection requires a username.
    verifyEmail Boolean
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
    appMetadata string
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    blocked boolean
    Indicates whether the user is blocked or not.
    connectionName string
    Name of the connection from which the user information was sourced.
    email string
    Email address of the user.
    emailVerified boolean
    Indicates whether the email address has been verified.
    familyName string
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    givenName string
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    nickname string
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    password string
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    permissions GetUserPermission[]
    List of API permissions granted to the user.
    phoneNumber string
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    phoneVerified boolean
    Indicates whether the phone number has been verified.
    picture string
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    roles string[]
    Set of IDs of roles assigned to the user.
    userId string
    ID of the user.
    userMetadata string
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    username string
    Username of the user. Only valid if the connection requires a username.
    verifyEmail boolean
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
    app_metadata str
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    blocked bool
    Indicates whether the user is blocked or not.
    connection_name str
    Name of the connection from which the user information was sourced.
    email str
    Email address of the user.
    email_verified bool
    Indicates whether the email address has been verified.
    family_name str
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    given_name str
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    nickname str
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    password str
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    permissions Sequence[GetUserPermission]
    List of API permissions granted to the user.
    phone_number str
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    phone_verified bool
    Indicates whether the phone number has been verified.
    picture str
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    roles Sequence[str]
    Set of IDs of roles assigned to the user.
    user_id str
    ID of the user.
    user_metadata str
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    username str
    Username of the user. Only valid if the connection requires a username.
    verify_email bool
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
    appMetadata String
    Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
    blocked Boolean
    Indicates whether the user is blocked or not.
    connectionName String
    Name of the connection from which the user information was sourced.
    email String
    Email address of the user.
    emailVerified Boolean
    Indicates whether the email address has been verified.
    familyName String
    Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    givenName String
    Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    nickname String
    Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    password String
    Initial password for this user. Required for non-passwordless connections (SMS and email).
    permissions List<Property Map>
    List of API permissions granted to the user.
    phoneNumber String
    Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
    phoneVerified Boolean
    Indicates whether the phone number has been verified.
    picture String
    Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
    roles List<String>
    Set of IDs of roles assigned to the user.
    userId String
    ID of the user.
    userMetadata String
    Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
    username String
    Username of the user. Only valid if the connection requires a username.
    verifyEmail Boolean
    Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.

    Supporting Types

    GetUserPermission

    Description string
    Description of the permission.
    Name string
    Name of the permission.
    ResourceServerIdentifier string
    Resource server identifier associated with the permission.
    ResourceServerName string
    Name of resource server that the permission is associated with.
    Description string
    Description of the permission.
    Name string
    Name of the permission.
    ResourceServerIdentifier string
    Resource server identifier associated with the permission.
    ResourceServerName string
    Name of resource server that the permission is associated with.
    description String
    Description of the permission.
    name String
    Name of the permission.
    resourceServerIdentifier String
    Resource server identifier associated with the permission.
    resourceServerName String
    Name of resource server that the permission is associated with.
    description string
    Description of the permission.
    name string
    Name of the permission.
    resourceServerIdentifier string
    Resource server identifier associated with the permission.
    resourceServerName string
    Name of resource server that the permission is associated with.
    description str
    Description of the permission.
    name str
    Name of the permission.
    resource_server_identifier str
    Resource server identifier associated with the permission.
    resource_server_name str
    Name of resource server that the permission is associated with.
    description String
    Description of the permission.
    name String
    Name of the permission.
    resourceServerIdentifier String
    Resource server identifier associated with the permission.
    resourceServerName String
    Name of resource server that the permission is associated with.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
    pulumi/pulumi-auth0