From 4389a32d9de671c4a5a6538d829b008f3b1e2574 Mon Sep 17 00:00:00 2001 From: mffap Date: Thu, 2 Mar 2023 10:29:36 +0200 Subject: [PATCH] docs: verified email (#5330) * docs: verified email * docs: email verified in api docs of import human user --------- Co-authored-by: Fabienne Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com> --- docs/docs/guides/manage/user/reg-create-user.md | 10 +++++++++- proto/zitadel/management.proto | 11 ++++++++--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/docs/guides/manage/user/reg-create-user.md b/docs/docs/guides/manage/user/reg-create-user.md index 3da64e457..d4788be2d 100644 --- a/docs/docs/guides/manage/user/reg-create-user.md +++ b/docs/docs/guides/manage/user/reg-create-user.md @@ -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. diff --git a/proto/zitadel/management.proto b/proto/zitadel/management.proto index 482402d43..2e919a7a3 100644 --- a/proto/zitadel/management.proto +++ b/proto/zitadel/management.proto @@ -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) = {