feat: User metadata (#2025)

* feat: user meta data events * feat: user meta data set tests * feat: user meta data tests * feat: user meta data in protos * feat: user meta data command api * feat: user meta data query side * feat: proto correct order, fix handlers * feat: proto correct order * feat: fixes of pr comments * feat: fixes of pr comments * feat: value as byte array * feat: metadata feature * Update internal/auth/repository/eventsourcing/handler/meta_data.go Co-authored-by: Silvan <silvan.reusser@gmail.com> * Update internal/command/user_meta_data.go Co-authored-by: Silvan <silvan.reusser@gmail.com> * Update proto/zitadel/metadata.proto Co-authored-by: Silvan <silvan.reusser@gmail.com> * Update proto/zitadel/metadata.proto Co-authored-by: Silvan <silvan.reusser@gmail.com> * fix: rename metadata files and table * fix: rename meta data to metadat in protos * Update internal/domain/metadata.go Co-authored-by: Silvan <silvan.reusser@gmail.com> * fix: rename vars * fix: rebiuld docs * Update internal/iam/repository/view/metadata_view.go Co-authored-by: Silvan <silvan.reusser@gmail.com> Co-authored-by: Silvan <silvan.reusser@gmail.com>
2025-08-12 00:47:33 +00:00 · 2021-08-09 08:01:20 +02:00
parent ae50f57c2c
commit 7451ed58f2
40 changed files with 3725 additions and 4 deletions
--- a/docs/docs/apis/proto/auth.md
+++ b/docs/docs/apis/proto/auth.md
@@ -67,6 +67,78 @@ Returns the user sessions of the authorized user of the current useragent
    POST: /users/me/sessions/_search


+### SetMyMetadata
+
+> **rpc** SetMyMetadata([SetMyMetadataRequest](#setmymetadatarequest))
+[SetMyMetadataResponse](#setmymetadataresponse)
+
+Sets a user metadata by key to the authorized user
+
+
+
+    POST: /users/me/metadata/{key}
+
+
+### BulkSetMyMetadata
+
+> **rpc** BulkSetMyMetadata([BulkSetMyMetadataRequest](#bulksetmymetadatarequest))
+[BulkSetMyMetadataResponse](#bulksetmymetadataresponse)
+
+Set a list of user metadata to the authorized user
+
+
+
+    POST: /users/me/metadata/_bulk
+
+
+### ListMyMetadata
+
+> **rpc** ListMyMetadata([ListMyMetadataRequest](#listmymetadatarequest))
+[ListMyMetadataResponse](#listmymetadataresponse)
+
+Returns the user metadata of the authorized user
+
+
+
+    POST: /users/me/metadata/_search
+
+
+### GetMyMetadata
+
+> **rpc** GetMyMetadata([GetMyMetadataRequest](#getmymetadatarequest))
+[GetMyMetadataResponse](#getmymetadataresponse)
+
+Returns the user metadata by key of the authorized user
+
+
+
+    GET: /users/me/metadata/{key}
+
+
+### RemoveMyMetadata
+
+> **rpc** RemoveMyMetadata([RemoveMyMetadataRequest](#removemymetadatarequest))
+[RemoveMyMetadataResponse](#removemymetadataresponse)
+
+Removes a user metadata by key to the authorized user
+
+
+
+    DELETE: /users/me/metadata/{key}
+
+
+### BulkRemoveMyMetadata
+
+> **rpc** BulkRemoveMyMetadata([BulkRemoveMyMetadataRequest](#bulkremovemymetadatarequest))
+[BulkRemoveMyMetadataResponse](#bulkremovemymetadataresponse)
+
+Set a list of user metadata to the authorized user
+
+
+
+    DELETE: /users/me/metadata/_bulk
+
+
 ### ListMyRefreshTokens

 > **rpc** ListMyRefreshTokens([ListMyRefreshTokensRequest](#listmyrefreshtokensrequest))
@@ -628,6 +700,62 @@ This is an empty request



+### BulkRemoveMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| keys | repeated string | - | repeated.items.string.min_len: 1<br /> repeated.items.string.max_len: 200<br />  |
+
+
+
+
+### BulkRemoveMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### BulkSetMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| metadata | repeated BulkSetMyMetadataRequest.Metadata | - |  |
+
+
+
+
+### BulkSetMyMetadataRequest.Metadata
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| value |  bytes | - | bytes.min_len: 1<br /> bytes.max_len: 500000<br />  |
+
+
+
+
+### BulkSetMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### GetMyEmailRequest
 This is an empty request

@@ -646,6 +774,28 @@ This is an empty request



+### GetMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### GetMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| metadata |  zitadel.metadata.v1.Metadata | - |  |
+
+
+
+
 ### GetMyPasswordComplexityPolicyRequest
 This is an empty request

@@ -811,6 +961,30 @@ This is an empty request



+### ListMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| query |  zitadel.v1.ListQuery | - |  |
+| queries | repeated zitadel.metadata.v1.MetadataQuery | - |  |
+
+
+
+
+### ListMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ListDetails | - |  |
+| result | repeated zitadel.metadata.v1.Metadata | - |  |
+
+
+
+
 ### ListMyPasswordlessRequest
 This is an empty request

@@ -1063,6 +1237,28 @@ This is an empty request



+### RemoveMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### RemoveMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### RemoveMyPasswordlessRequest


@@ -1209,6 +1405,29 @@ This is an empty request



+### SetMyMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| value |  bytes | - | bytes.min_len: 1<br /> bytes.max_len: 500000<br />  |
+
+
+
+
+### SetMyMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### SetMyPhoneRequest


--- a/docs/docs/apis/proto/management.md
+++ b/docs/docs/apis/proto/management.md
@@ -236,6 +236,78 @@ Changes the username
    GET: /users/{user_id}/username


+### SetUserMetadata
+
+> **rpc** SetUserMetadata([SetUserMetadataRequest](#setusermetadatarequest))
+[SetUserMetadataResponse](#setusermetadataresponse)
+
+Sets a user metadata by key
+
+
+
+    POST: /users/{id}/metadata/{key}
+
+
+### BulkSetUserMetadata
+
+> **rpc** BulkSetUserMetadata([BulkSetUserMetadataRequest](#bulksetusermetadatarequest))
+[BulkSetUserMetadataResponse](#bulksetusermetadataresponse)
+
+Set a list of user metadata
+
+
+
+    POST: /users/{id}/metadata/_bulk
+
+
+### ListUserMetadata
+
+> **rpc** ListUserMetadata([ListUserMetadataRequest](#listusermetadatarequest))
+[ListUserMetadataResponse](#listusermetadataresponse)
+
+Returns the user metadata
+
+
+
+    POST: /users/{id}/metadata/_search
+
+
+### GetUserMetadata
+
+> **rpc** GetUserMetadata([GetUserMetadataRequest](#getusermetadatarequest))
+[GetUserMetadataResponse](#getusermetadataresponse)
+
+Returns the user metadata by key
+
+
+
+    GET: /users/{id}/metadata/{key}
+
+
+### RemoveUserMetadata
+
+> **rpc** RemoveUserMetadata([RemoveUserMetadataRequest](#removeusermetadatarequest))
+[RemoveUserMetadataResponse](#removeusermetadataresponse)
+
+Removes a user metadata by key
+
+
+
+    DELETE: /users/{id}/metadata/{key}
+
+
+### BulkRemoveUserMetadata
+
+> **rpc** BulkRemoveUserMetadata([BulkRemoveUserMetadataRequest](#bulkremoveusermetadatarequest))
+[BulkRemoveUserMetadataResponse](#bulkremoveusermetadataresponse)
+
+Set a list of user metadata
+
+
+
+    DELETE: /users/{id}/metadata/_bulk
+
+
 ### GetHumanProfile

 > **rpc** GetHumanProfile([GetHumanProfileRequest](#gethumanprofilerequest))
@@ -3347,6 +3419,64 @@ This is an empty request



+### BulkRemoveUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| keys | repeated string | - | repeated.items.string.min_len: 1<br /> repeated.items.string.max_len: 200<br />  |
+
+
+
+
+### BulkRemoveUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### BulkSetUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| metadata | repeated BulkSetUserMetadataRequest.Metadata | - |  |
+
+
+
+
+### BulkSetUserMetadataRequest.Metadata
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| value |  bytes | - | bytes.min_len: 1<br /> bytes.max_len: 500000<br />  |
+
+
+
+
+### BulkSetUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### DeactivateAppRequest


@@ -4480,6 +4610,29 @@ This is an empty request



+### GetUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### GetUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| metadata |  zitadel.metadata.v1.Metadata | - |  |
+
+
+
+
 ### HealthzRequest
 This is an empty request

@@ -5264,6 +5417,31 @@ This is an empty request



+### ListUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| query |  zitadel.v1.ListQuery | - |  |
+| queries | repeated zitadel.metadata.v1.MetadataQuery | - |  |
+
+
+
+
+### ListUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ListDetails | - |  |
+| result | repeated zitadel.metadata.v1.Metadata | - |  |
+
+
+
+
 ### ListUsersRequest


@@ -6068,6 +6246,29 @@ This is an empty response



+### RemoveUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### RemoveUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### RemoveUserRequest


@@ -6756,6 +6957,31 @@ This is an empty request



+### SetUserMetadataRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| key |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| value |  bytes | - | bytes.min_len: 1<br /> bytes.max_len: 500000<br />  |
+
+
+
+
+### SetUserMetadataResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
 ### UnlockUserRequest


--- a/docs/docs/apis/proto/metadata.md
+++ b/docs/docs/apis/proto/metadata.md
@@ -0,0 +1,49 @@
+---
+title: zitadel/metadata.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Metadata
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| key |  string | - |  |
+| value |  bytes | - |  |
+
+
+
+
+### MetadataKeyQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### MetadataQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.key_query |  MetadataKeyQuery | - |  |
+
+
+
+
+
+
--- a/docs/docs/apis/proto/text.md
+++ b/docs/docs/apis/proto/text.md
@@ -0,0 +1,601 @@
+---
+title: zitadel/text.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### EmailVerificationDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| login_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### EmailVerificationScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### ExternalUserNotFoundScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| link_button_text |  string | - | string.max_len: 100<br />  |
+| auto_register_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### FooterText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| tos |  string | - | string.max_len: 200<br />  |
+| privacy_policy |  string | - | string.max_len: 200<br />  |
+| help |  string | - | string.max_len: 200<br />  |
+| help_link |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### InitMFADoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAOTPScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_otp |  string | - | string.max_len: 500<br />  |
+| secret_label |  string | - | string.max_len: 200<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAPromptScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| otp_option |  string | - | string.max_len: 200<br />  |
+| u2f_option |  string | - | string.max_len: 200<br />  |
+| skip_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAU2FScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| token_name_label |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| register_token_button_text |  string | - | string.max_len: 100<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### InitPasswordDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitPasswordScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitializeUserDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitializeUserScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### LinkingUserDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### LoginCustomText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| select_account_text |  SelectAccountScreenText | - |  |
+| login_text |  LoginScreenText | - |  |
+| password_text |  PasswordScreenText | - |  |
+| username_change_text |  UsernameChangeScreenText | - |  |
+| username_change_done_text |  UsernameChangeDoneScreenText | - |  |
+| init_password_text |  InitPasswordScreenText | - |  |
+| init_password_done_text |  InitPasswordDoneScreenText | - |  |
+| email_verification_text |  EmailVerificationScreenText | - |  |
+| email_verification_done_text |  EmailVerificationDoneScreenText | - |  |
+| initialize_user_text |  InitializeUserScreenText | - |  |
+| initialize_done_text |  InitializeUserDoneScreenText | - |  |
+| init_mfa_prompt_text |  InitMFAPromptScreenText | - |  |
+| init_mfa_otp_text |  InitMFAOTPScreenText | - |  |
+| init_mfa_u2f_text |  InitMFAU2FScreenText | - |  |
+| init_mfa_done_text |  InitMFADoneScreenText | - |  |
+| mfa_providers_text |  MFAProvidersText | - |  |
+| verify_mfa_otp_text |  VerifyMFAOTPScreenText | - |  |
+| verify_mfa_u2f_text |  VerifyMFAU2FScreenText | - |  |
+| passwordless_text |  PasswordlessScreenText | - |  |
+| password_change_text |  PasswordChangeScreenText | - |  |
+| password_change_done_text |  PasswordChangeDoneScreenText | - |  |
+| password_reset_done_text |  PasswordResetDoneScreenText | - |  |
+| registration_option_text |  RegistrationOptionScreenText | - |  |
+| registration_user_text |  RegistrationUserScreenText | - |  |
+| registration_org_text |  RegistrationOrgScreenText | - |  |
+| linking_user_done_text |  LinkingUserDoneScreenText | - |  |
+| external_user_not_found_text |  ExternalUserNotFoundScreenText | - |  |
+| success_login_text |  SuccessLoginScreenText | - |  |
+| logout_text |  LogoutDoneScreenText | - |  |
+| footer_text |  FooterText | - |  |
+| passwordless_prompt_text |  PasswordlessPromptScreenText | - |  |
+| passwordless_registration_text |  PasswordlessRegistrationScreenText | - |  |
+| passwordless_registration_done_text |  PasswordlessRegistrationDoneScreenText | - |  |
+
+
+
+
+### LoginScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| title_linking_process |  string | - | string.max_len: 200<br />  |
+| description_linking_process |  string | - | string.max_len: 500<br />  |
+| user_must_be_member_of_org |  string | - | string.max_len: 500<br />  |
+| login_name_label |  string | - | string.max_len: 200<br />  |
+| register_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| external_user_description |  string | - | string.max_len: 500<br />  |
+| user_name_placeholder |  string | - | string.max_len: 200<br />  |
+| login_name_placeholder |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### LogoutDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| login_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MFAProvidersText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| choose_other |  string | - | string.max_len: 500<br />  |
+| otp |  string | - | string.max_len: 200<br />  |
+| u2f |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MessageCustomText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| title |  string | - |  |
+| pre_header |  string | - |  |
+| subject |  string | - |  |
+| greeting |  string | - |  |
+| text |  string | - |  |
+| button_text |  string | - |  |
+| footer_text |  string | - |  |
+
+
+
+
+### PasswordChangeDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordChangeScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| old_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordResetDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| reset_link_text |  string | - | string.max_len: 100<br />  |
+| back_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| min_length |  string | - | string.max_len: 100<br />  |
+| has_uppercase |  string | - | string.max_len: 100<br />  |
+| has_lowercase |  string | - | string.max_len: 100<br />  |
+| has_number |  string | - | string.max_len: 100<br />  |
+| has_symbol |  string | - | string.max_len: 100<br />  |
+| confirmation |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessPromptScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_init |  string | - | string.max_len: 500<br />  |
+| passwordless_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| skip_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessRegistrationDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessRegistrationScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| token_name_label |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| register_token_button_text |  string | - | string.max_len: 100<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### PasswordlessScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| login_with_pw_button_text |  string | - | string.max_len: 100<br />  |
+| validate_token_button_text |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### RegistrationOptionScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| user_name_button_text |  string | - | string.max_len: 200<br />  |
+| external_login_description |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### RegistrationOrgScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| orgname_label |  string | - | string.max_len: 200<br />  |
+| firstname_label |  string | - | string.max_len: 200<br />  |
+| lastname_label |  string | - | string.max_len: 200<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| email_label |  string | - | string.max_len: 200<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| password_confirm_label |  string | - | string.max_len: 200<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| save_button_text |  string | - | string.max_len: 200<br />  |
+| tos_confirm_and |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### RegistrationUserScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_org_register |  string | - | string.max_len: 500<br />  |
+| firstname_label |  string | - | string.max_len: 200<br />  |
+| lastname_label |  string | - | string.max_len: 200<br />  |
+| email_label |  string | - | string.max_len: 200<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| language_label |  string | - | string.max_len: 200<br />  |
+| gender_label |  string | - | string.max_len: 200<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| password_confirm_label |  string | - | string.max_len: 200<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 200<br />  |
+| back_button_text |  string | - | string.max_len: 200<br />  |
+| tos_confirm_and |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### SelectAccountScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| title_linking_process |  string | - | string.max_len: 200<br />  |
+| description_linking_process |  string | - | string.max_len: 500<br />  |
+| other_user |  string | - | string.max_len: 500<br />  |
+| session_state_active |  string | - | string.max_len: 100<br />  |
+| session_state_inactive |  string | - | string.max_len: 100<br />  |
+| user_must_be_member_of_org |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### SuccessLoginScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| auto_redirect_description |  string | Text to describe that auto redirect should happen after successful login | string.max_len: 500<br />  |
+| redirected_description |  string | Text to describe that the window can be closed after redirect | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### UsernameChangeDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### UsernameChangeScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### VerifyMFAOTPScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### VerifyMFAU2FScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| validate_token_text |  string | - | string.max_len: 500<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+
+