docs: verified email (#5330)

* 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
2 changed files with 17 additions and 4 deletions

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) = {