Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getUser
Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.getUser

Explore with Pulumi AI

Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

Data source to retrieve a specific Auth0 user by user_id or by lucene query. If filtered by Lucene Query, it should include sufficient filters to retrieve a unique user.

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(query: Optional[str] = None,
             user_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(query: Optional[pulumi.Input[str]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
Copy
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: auth0:index/getUser:getUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Query string
Lucene Query for retrieving a user.
UserId string
ID of the user.
Query string
Lucene Query for retrieving a user.
UserId string
ID of the user.
query String
Lucene Query for retrieving a user.
userId String
ID of the user.
query string
Lucene Query for retrieving a user.
userId string
ID of the user.
query str
Lucene Query for retrieving a user.
user_id str
ID of the user.
query String
Lucene Query for retrieving a 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.
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.
Query string
Lucene Query for retrieving a user.
UserId string
ID of the user.
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.
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.
Query string
Lucene Query for retrieving a user.
UserId string
ID of the user.
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.
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.
query String
Lucene Query for retrieving a user.
userId String
ID of the user.
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.
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.
query string
Lucene Query for retrieving a user.
userId string
ID of the user.
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_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.
query str
Lucene Query for retrieving a user.
user_id str
ID of the user.
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.
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.
query String
Lucene Query for retrieving a user.
userId String
ID of the user.

Supporting Types

GetUserPermission

Description This property is required. string
Description of the permission.
Name This property is required. string
Name of the permission.
ResourceServerIdentifier This property is required. string
Resource server identifier associated with the permission.
ResourceServerName This property is required. string
Name of resource server that the permission is associated with.
Description This property is required. string
Description of the permission.
Name This property is required. string
Name of the permission.
ResourceServerIdentifier This property is required. string
Resource server identifier associated with the permission.
ResourceServerName This property is required. string
Name of resource server that the permission is associated with.
description This property is required. String
Description of the permission.
name This property is required. String
Name of the permission.
resourceServerIdentifier This property is required. String
Resource server identifier associated with the permission.
resourceServerName This property is required. String
Name of resource server that the permission is associated with.
description This property is required. string
Description of the permission.
name This property is required. string
Name of the permission.
resourceServerIdentifier This property is required. string
Resource server identifier associated with the permission.
resourceServerName This property is required. string
Name of resource server that the permission is associated with.
description This property is required. str
Description of the permission.
name This property is required. str
Name of the permission.
resource_server_identifier This property is required. str
Resource server identifier associated with the permission.
resource_server_name This property is required. str
Name of resource server that the permission is associated with.
description This property is required. String
Description of the permission.
name This property is required. String
Name of the permission.
resourceServerIdentifier This property is required. String
Resource server identifier associated with the permission.
resourceServerName This property is required. 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 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0