Back to Node Auth0

Interface SignUpResponse

docs/interfaces/auth.SignUpResponse.html

5.9.12.1 KB
Original Source
  • auth
  • SignUpResponse

Interface SignUpResponse

interface SignUpResponse {
email: string;
email_verified: boolean;
id: string;
username?: string;
given_name?: string;
family_name?: string;
name?: string;
nickname?: string;
picture?: string;
user_metadata?: { [key: string]: unknown };
}

Index

Properties

emailemail_verifiedidusername?given_name?family_name?name?nickname?picture?user_metadata?

Properties

email

email: string

Email address of the new user.

email_verified

email_verified: boolean

Indicates whether the email has been verified or not.

id

id: string

The server can return _id, id or user_id depending on various factors. For convenience we expose it here as just id.

Optionalusername

username?: string

Username of this user.

Optionalgiven_name

given_name?: string

The user's given name(s).

Optionalfamily_name

family_name?: string

The user's family name(s).

Optionalname

name?: string

The user's full name.

Optionalnickname

nickname?: string

The user's nickname.

Optionalpicture

picture?: string

A URI pointing to the user's picture.

Optionaluser_metadata

user_metadata?: { [key: string]: unknown }

The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties. Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties emailemail_verifiedidusernamegiven_namefamily_namenamenicknamepictureuser_metadata