docs/interfaces/management.Management.CreateUserRequestContent.html
{ * connection: "connection" * }Copy
interface CreateUserRequestContent {
email?: string;
phone_number?: string;
user_metadata?: UserMetadata;
blocked?: boolean;
email_verified?: boolean;
phone_verified?: boolean;
app_metadata?: AppMetadata;
given_name?: string;
family_name?: string;
name?: string;
nickname?: string;
picture?: string;
user_id?: string;
connection: string;
password?: string;
verify_email?: boolean;
username?: string;
}
email?phone_number?user_metadata?blocked?email_verified?phone_verified?app_metadata?given_name?family_name?name?nickname?picture?user_id?connectionpassword?verify_email?username?
Optionalemailemail?: string
The user's email.
Optionalphone_numberphone_number?: string
The user's phone number (following the E.164 recommendation).
Optionaluser_metadatauser_metadata?: UserMetadata
Optionalblockedblocked?: boolean
Whether this user was blocked by an administrator (true) or not (false).
Optionalemail_verifiedemail_verified?: boolean
Whether this email address is verified (true) or unverified (false). User will receive a verification email after creation if email_verified is false or not specified
Optionalphone_verifiedphone_verified?: boolean
Whether this phone number has been verified (true) or not (false).
Optionalapp_metadataapp_metadata?: AppMetadata
Optionalgiven_namegiven_name?: string
The user's given name(s).
Optionalfamily_namefamily_name?: string
The user's family name(s).
Optionalnamename?: string
The user's full name.
Optionalnicknamenickname?: string
The user's nickname.
Optionalpicturepicture?: string
A URI pointing to the user's picture.
Optionaluser_iduser_id?: string
The external user's id provided by the identity provider.
connection: string
Name of the connection this user should be created in.
Optionalpasswordpassword?: string
Initial password for this user. Only valid for auth0 connection strategy.
Optionalverify_emailverify_email?: boolean
Whether the user will receive a verification email after creation (true) or no email (false). Overrides behavior of email_verified parameter.
Optionalusernameusername?: string
The user's username. Only valid if the connection requires a username.
Member Visibility
ThemeOSLightDark
Properties emailphone_numberuser_metadatablockedemail_verifiedphone_verifiedapp_metadatagiven_namefamily_namenamenicknamepictureuser_idconnectionpasswordverify_emailusername