​

SignUpSecurityKeyOptions

​

Parameters

locale optional string

Locale of the user, in two digits

allowedRoles optional Array<string>

Allowed roles of the user. Must be a subset of the default allowed roles defined in Hasura Auth.

defaultRole optional string

Default role of the user. Must be part of the default allowed roles defined in Hasura Auth.

displayName optional string

Display name of the user. If not provided, it will use the display name given by the social provider (Oauth) used on registration, or the email address otherwise.

metadata optional Record<string, unknown>

Custom additional user information stored in the metadata column. Can be any JSON object.

redirectTo optional string

Redirection path in the client application that will be used in the link in the verification email. For instance, if you want to redirect to https://myapp.com/success, the redirectTo value is '/success'.

nickname optional string

Optional nickname for the security key