TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-03-01 00:17:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: verified email (#5330)

Browse Source 
* docs: verified email

* docs: email verified in api docs of import human user

---------

Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
This commit is contained in:
mffap 2023-03-02 10:29:36 +02:00 committed by GitHub
parent ed4983d3fd
commit 4389a32d9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/guides/manage/user/reg-create-user.md
View File

@ -5,7 +5,8 @@ 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/mgmt)
Use the following API call to create your users:
[Create User (Human)](/apis/mgmt/management-service-import-human-user.api.mdx)
## With Username and Password
@ -39,3 +40,10 @@ 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/mgmt)
## Verified Email Address
When creating users you can define wether you want to verify their email address before activating the user.
In case you want to create the user with an verified email address set the `isEmailVerified` property to `true`.
No initialization email will be sent to the user.

11
proto/zitadel/management.proto
View File

@ -453,9 +453,10 @@ service ManagementService {
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Create User (Human)";
description: "Create a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login."
summary: "Create/Import User (Human)";
description: "Create/import a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login."
tags: "Users";
tags: "User Human"
parameters: {
headers: {
name: "x-zitadel-orgid";
@ -7088,7 +7089,11 @@ message ImportHumanUserRequest {
example: "\"minnie@mouse.com\"";
description: "Object that contains the email address and a verified flag."
}];
bool is_email_verified = 2;
bool is_email_verified = 2 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "If email verified is set to true, the email will be added as verified and the user doesn't have to verify."
}
];
}
message Phone {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {