Internal Authentication Flow
This flow is executed if the user logs in using the login UI hosted by ZITADEL.
The flow is represented by the following Ids in the API: 3
Post Authentication​
A user has authenticated directly at ZITADEL. ZITADEL validated the users inputs for password, one-time password, security key or passwordless factor. Each validation step triggers the action.
The trigger is represented by the following Ids in the API: TRIGGER_TYPE_POST_AUTHENTICATION
or 1
.
Parameters of Post Authentication Action​
ctx
The first parameter contains the following fieldsv1
authMethod
string
This is one of "password", "OTP", "U2F" or "passwordless"authError
string
This is a verification errors string representation. If the verification succeeds, this is "none"authRequest
auth requesthttpRequest
http request
api
The second parameter contains the following fieldsmetadata
Array of metadata. This function is deprecated, please useapi.v1.user.appendMetadata
v1
user
appendMetadata(string, Any)
The first parameter represents the key and the second a value which will be stored
Pre Creation​
A user registers directly at ZITADEL. ZITADEL did not create the user yet.
The trigger is represented by the following Ids in the API: TRIGGER_TYPE_PRE_CREATION
or 2
.
Parameters of Pre Creation​
ctx
The first parameter contains the following fieldsv1
user
humanauthRequest
auth requesthttpRequest
http request
api
The second parameter contains the following fieldsmetadata
Array of metadata. This function is deprecated, please useapi.v1.user.appendMetadata
setFirstName(string)
Sets the first namesetLastName(string)
Sets the last namesetNickName(string)
Sets the nick namesetDisplayName(string)
Sets the display namesetPreferredLanguage(string)
Sets the preferred language, the string has to be a valid language tag as defined in RFC 5646setGender(int)
Sets the gender.- 0: unspecified
- 1: female
- 2: male
- 3: diverse
setUsername(string)
Sets the usernamesetEmail(string)
Sets the emailsetEmailVerified(bool)
If true the email set is verified without user interactionsetPhone(string)
Sets the phone numbersetPhoneVerified(bool)
If true the phone number set is verified without user interactionv1
user
appendMetadata(string, Any)
The first parameter represents the key and the second a value which will be stored
Post Creation​
A user registers directly at ZITADEL.
ZITADEL successfully created the user.
The trigger is represented by the following Ids in the API: TRIGGER_TYPE_POST_CREATION
or 3
.
Parameters of Post Creation​
ctx
The first parameter contains the following fieldsv1
getUser()
userauthRequest
auth requesthttpRequest
http request
api
The second parameter contains the following fields