mirror of
https://github.com/zitadel/zitadel.git
synced 2026-08-19 01:14:48 -05:00
chore(docs): User (Human) naming consistency (#11512)
# Which Problems Are Solved Naming inconsistencies - User (Human) # How the Problems Are Solved Most of the occurrences have not been changed. `User (Human)` was mostly changed when talking about code objects and where I felt it was necessary to distinguish them from machine users. When both human and machine user occurrences were found, the machine user has been changed to service account (see https://github.com/zitadel/zitadel/issues/11285) # Additional Context - Closes #11284 --------- Co-authored-by: Wim Van Laer <wim+github@zitadel.com>
This commit is contained in:
@@ -284,7 +284,7 @@ service ManagementService {
|
||||
//
|
||||
// Deprecated: use [user service v2 ListUsers with InUserIDQuery](apis/resources/user_service_v2/user-service-list-users.api.mdx) instead.
|
||||
//
|
||||
// Returns the full user object (human or machine) including the profile, email, etc.
|
||||
// Returns the full user or Service Account including the profile, email, etc.
|
||||
rpc GetUserByID(GetUserByIDRequest) returns (GetUserByIDResponse) {
|
||||
option (google.api.http) = {
|
||||
get: "/users/{id}"
|
||||
@@ -444,7 +444,7 @@ service ManagementService {
|
||||
//
|
||||
// Deprecated: use [user service v2 CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) instead.
|
||||
//
|
||||
// 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.
|
||||
// Create a new user. 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.
|
||||
rpc AddHumanUser(AddHumanUserRequest) returns (AddHumanUserResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/users/human"
|
||||
@@ -473,7 +473,7 @@ service ManagementService {
|
||||
//
|
||||
// Deprecated: use [user service v2 UpdateHumanUser](apis/resources/user_service_v2/user-service-update-human-user.api.mdx) instead.
|
||||
//
|
||||
// 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.
|
||||
// Create/import a new user. 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.
|
||||
rpc ImportHumanUser(ImportHumanUserRequest) returns (ImportHumanUserResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/users/human/_import"
|
||||
|
||||
@@ -129,7 +129,7 @@ service UserService {
|
||||
|
||||
// Create a User
|
||||
//
|
||||
// Create a new human or machine user in the specified organization.
|
||||
// Create a new user or service account in the specified organization.
|
||||
//
|
||||
// Required permission:
|
||||
// - user.write
|
||||
@@ -168,11 +168,11 @@ service UserService {
|
||||
};
|
||||
}
|
||||
|
||||
// Create a new human user
|
||||
// Create a new User (Human)
|
||||
//
|
||||
// Deprecated: Use [CreateUser](/docs/reference/api/user/zitadel.user.v2.UserService.CreateUser) to create a new user of type human instead.
|
||||
// Deprecated: Use [CreateUser](/docs/reference/api/user/zitadel.user.v2.UserService.CreateUser) to create a new user.
|
||||
//
|
||||
// Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
|
||||
// Create/import a new user. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
|
||||
rpc AddHumanUser (AddHumanUserRequest) returns (AddHumanUserResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v2/users/human"
|
||||
@@ -202,7 +202,7 @@ service UserService {
|
||||
|
||||
// User by ID
|
||||
//
|
||||
// Returns the full user object (human or machine) including the profile, email, etc..
|
||||
// Returns the full user or Service Account including the profile, email, etc..
|
||||
rpc GetUserByID(GetUserByIDRequest) returns (GetUserByIDResponse) {
|
||||
option (google.api.http) = {
|
||||
get: "/v2/users/{user_id}"
|
||||
@@ -574,9 +574,9 @@ service UserService {
|
||||
};
|
||||
}
|
||||
|
||||
// Update Human User
|
||||
// Update User (Human)
|
||||
//
|
||||
// Deprecated: Use [UpdateUser](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser) to update a user of type human instead.
|
||||
// Deprecated: Use [UpdateUser](/docs/reference/api/user/zitadel.user.v2.UserService.UpdateUser) to update a user.
|
||||
//
|
||||
// Update all information from a user.
|
||||
rpc UpdateHumanUser(UpdateHumanUserRequest) returns (UpdateHumanUserResponse) {
|
||||
@@ -2138,7 +2138,7 @@ message CreateUserRequest{
|
||||
];
|
||||
|
||||
// The username is a unique identifier for the user in the organization.
|
||||
// If not specified, Zitadel sets the username to the email for users of type human and to the user_id for users of type machine.
|
||||
// If not specified, Zitadel sets the username to the email for user and to the user_id for Service Accounts.
|
||||
// It is used to identify the user in the organization and can be used for login.
|
||||
optional string username = 3 [
|
||||
(validate.rules).string = {min_len: 1, max_len: 200},
|
||||
|
||||
@@ -111,9 +111,9 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
|
||||
// Deprecated: use user service v2 instead. This service will be removed in the next major version of ZITADEL.
|
||||
service UserService {
|
||||
|
||||
// Create a new human user
|
||||
// Create a new User (Human)
|
||||
//
|
||||
// Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
|
||||
// Create/import a new user. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
|
||||
//
|
||||
// Deprecated: please move to the corresponding endpoint under user service v2 (GA)
|
||||
rpc AddHumanUser (AddHumanUserRequest) returns (AddHumanUserResponse) {
|
||||
@@ -145,7 +145,7 @@ service UserService {
|
||||
|
||||
// User by ID
|
||||
//
|
||||
// Returns the full user object (human or machine) including the profile, email, etc.
|
||||
// Returns the full user or Service Account including the profile, email, etc.
|
||||
//
|
||||
// Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
||||
rpc GetUserByID(GetUserByIDRequest) returns (GetUserByIDResponse) {
|
||||
|
||||
Reference in New Issue
Block a user