mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-13 03:24:26 +00:00
docs: passwordless registration (#4743)
* docs: passwordless registration * docs: passwordless registration
This commit is contained in:
parent
f4e2349440
commit
35832fdd80
43
docs/docs/guides/manage/user/reg-create-user.md
Normal file
43
docs/docs/guides/manage/user/reg-create-user.md
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
title: Register and Create User
|
||||
---
|
||||
|
||||
The ZITADEL API has different possibilities to create users.
|
||||
This can be used, if you are building your own registration page.
|
||||
|
||||
[Import Human User](../../../apis/proto/management#importhumanuser)
|
||||
|
||||
## With Username and Password
|
||||
|
||||
If you are collecting all the user information and a password, you can directly create the user with the password.
|
||||
With the `password_change_required` flag you can choose if the user has to change the password on the first login or not.
|
||||
This might make sense if an administrator created the user.
|
||||
|
||||
## With passwordless
|
||||
|
||||
You can directly ask for a link to create the passwordless registration for the user.
|
||||
Fill the user data and set the attribute `request_passwordless_registration` to true.
|
||||
You will get a link for the registration and an expiration time in the response.
|
||||
|
||||
If you add `requestPlatformType` as query parameter to the link you can define what type the platform should be.
|
||||
- **platform**: Device itself e.g. FaceID, Fingerprint etc.
|
||||
- **crossPlatform** A hardware token e.g SoloKey
|
||||
- **unspecified** The user is free to choose
|
||||
|
||||
If nothing is requested, the type will not be restricted and all possibilities of the device will be taken into account.
|
||||
|
||||
### Add passwordless to existing user
|
||||
|
||||
If you already have a user in ZITADEL, it is possible to add passworless later.
|
||||
|
||||
[Add Passwordless Registration ](../../../apis/proto/management#addpasswordlessregistration)
|
||||
|
||||
Send the user_id in the request and you will get a link and an expiration as response.
|
||||
You can then customize the link the same as described above in the creation process.
|
||||
|
||||
The second possibility is to send the link directly to the user per email.
|
||||
Use the following request in that case:
|
||||
|
||||
[Send Passwordless Registration ](../../../apis/proto/management#sendpasswordlessregistration)
|
||||
|
||||
|
@ -117,6 +117,7 @@ module.exports = {
|
||||
label: "Terraform",
|
||||
items: ["guides/manage/terraform/basics"],
|
||||
},
|
||||
"guides/manage/user/reg-create-user",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user