Skip to main content

zitadel/text.proto

This document reflects the state from API 1.0 (available from 20.04.2021)

Messages

EmailVerificationDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100
cancel_button_textstring-string.max_len: 100
login_button_textstring-string.max_len: 100

EmailVerificationScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
code_labelstring-string.max_len: 200
next_button_textstring-string.max_len: 100
resend_button_textstring-string.max_len: 100

ExternalRegistrationUserOverviewScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
email_labelstring-string.max_len: 200
username_labelstring-string.max_len: 200
firstname_labelstring-string.max_len: 200
lastname_labelstring-string.max_len: 200
nickname_labelstring-string.max_len: 200
language_labelstring-string.max_len: 200
phone_labelstring-string.max_len: 200
tos_and_privacy_labelstring-string.max_len: 200
tos_confirmstring-string.max_len: 200
tos_link_textstring-string.max_len: 200
tos_confirm_andstring-string.max_len: 200
privacy_link_textstring-string.max_len: 200
back_button_textstring-string.max_len: 200
next_button_textstring-string.max_len: 200

ExternalUserNotFoundScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
link_button_textstring-string.max_len: 100
auto_register_button_textstring-string.max_len: 100
tos_and_privacy_labelstring-string.max_len: 200
tos_confirmstring-string.max_len: 200
tos_link_textstring-string.max_len: 200
privacy_link_textstring-string.max_len: 200
tos_confirm_andstring-string.max_len: 200

FooterText

FieldTypeDescriptionValidation
tosstring-string.max_len: 200
privacy_policystring-string.max_len: 200
helpstring-string.max_len: 200
help_linkstring-string.max_len: 500

InitMFADoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
cancel_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

InitMFAOTPScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
description_otpstring-string.max_len: 500
secret_labelstring-string.max_len: 200
code_labelstring-string.max_len: 200
next_button_textstring-string.max_len: 100
cancel_button_textstring-string.max_len: 100

InitMFAPromptScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
otp_optionstring-string.max_len: 200
u2f_optionstring-string.max_len: 200
skip_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

InitMFAU2FScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
token_name_labelstring-string.max_len: 200
not_supportedstring-string.max_len: 500
register_token_button_textstring-string.max_len: 100
error_retrystring-string.max_len: 500

InitPasswordDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100
cancel_button_textstring-string.max_len: 100

InitPasswordScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
code_labelstring-string.max_len: 200
new_password_labelstring-string.max_len: 200
new_password_confirm_labelstring-string.max_len: 200
next_button_textstring-string.max_len: 100
resend_button_textstring-string.max_len: 100

InitializeUserDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
cancel_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

InitializeUserScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
code_labelstring-string.max_len: 200
new_password_labelstring-string.max_len: 200
new_password_confirm_labelstring-string.max_len: 200
resend_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

LinkingUserDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
cancel_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

LoginCustomText

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
select_account_textSelectAccountScreenText-
login_textLoginScreenText-
password_textPasswordScreenText-
username_change_textUsernameChangeScreenText-
username_change_done_textUsernameChangeDoneScreenText-
init_password_textInitPasswordScreenText-
init_password_done_textInitPasswordDoneScreenText-
email_verification_textEmailVerificationScreenText-
email_verification_done_textEmailVerificationDoneScreenText-
initialize_user_textInitializeUserScreenText-
initialize_done_textInitializeUserDoneScreenText-
init_mfa_prompt_textInitMFAPromptScreenText-
init_mfa_otp_textInitMFAOTPScreenText-
init_mfa_u2f_textInitMFAU2FScreenText-
init_mfa_done_textInitMFADoneScreenText-
mfa_providers_textMFAProvidersText-
verify_mfa_otp_textVerifyMFAOTPScreenText-
verify_mfa_u2f_textVerifyMFAU2FScreenText-
passwordless_textPasswordlessScreenText-
password_change_textPasswordChangeScreenText-
password_change_done_textPasswordChangeDoneScreenText-
password_reset_done_textPasswordResetDoneScreenText-
registration_option_textRegistrationOptionScreenText-
registration_user_textRegistrationUserScreenText-
registration_org_textRegistrationOrgScreenText-
linking_user_done_textLinkingUserDoneScreenText-
external_user_not_found_textExternalUserNotFoundScreenText-
success_login_textSuccessLoginScreenText-
logout_textLogoutDoneScreenText-
footer_textFooterText-
passwordless_prompt_textPasswordlessPromptScreenText-
passwordless_registration_textPasswordlessRegistrationScreenText-
passwordless_registration_done_textPasswordlessRegistrationDoneScreenText-
external_registration_user_overview_textExternalRegistrationUserOverviewScreenText-
is_defaultbool-

LoginScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
title_linking_processstring-string.max_len: 200
description_linking_processstring-string.max_len: 500
user_must_be_member_of_orgstring-string.max_len: 500
login_name_labelstring-string.max_len: 200
register_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100
external_user_descriptionstring-string.max_len: 500
user_name_placeholderstring-string.max_len: 200
login_name_placeholderstring-string.max_len: 200

LogoutDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
login_button_textstring-string.max_len: 200

MFAProvidersText

FieldTypeDescriptionValidation
choose_otherstring-string.max_len: 500
otpstring-string.max_len: 200
u2fstring-string.max_len: 200

MessageCustomText

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
titlestring-
pre_headerstring-
subjectstring-
greetingstring-
textstring-
button_textstring-
footer_textstring-
is_defaultbool-

PasswordChangeDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100

PasswordChangeScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
old_password_labelstring-string.max_len: 200
new_password_labelstring-string.max_len: 200
new_password_confirm_labelstring-string.max_len: 200
cancel_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

PasswordResetDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100

PasswordScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
password_labelstring-string.max_len: 200
reset_link_textstring-string.max_len: 100
back_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100
min_lengthstring-string.max_len: 100
has_uppercasestring-string.max_len: 100
has_lowercasestring-string.max_len: 100
has_numberstring-string.max_len: 100
has_symbolstring-string.max_len: 100
confirmationstring-string.max_len: 100

PasswordlessPromptScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
description_initstring-string.max_len: 500
passwordless_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100
skip_button_textstring-string.max_len: 100

PasswordlessRegistrationDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100
cancel_button_textstring-string.max_len: 100
description_closestring-string.max_len: 100

PasswordlessRegistrationScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
token_name_labelstring-string.max_len: 200
not_supportedstring-string.max_len: 500
register_token_button_textstring-string.max_len: 100
error_retrystring-string.max_len: 500

PasswordlessScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
login_with_pw_button_textstring-string.max_len: 100
validate_token_button_textstring-string.max_len: 200
not_supportedstring-string.max_len: 500
error_retrystring-string.max_len: 500

RegistrationOptionScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
user_name_button_textstring-string.max_len: 200
external_login_descriptionstring-string.max_len: 500

RegistrationOrgScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
orgname_labelstring-string.max_len: 200
firstname_labelstring-string.max_len: 200
lastname_labelstring-string.max_len: 200
username_labelstring-string.max_len: 200
email_labelstring-string.max_len: 200
password_labelstring-string.max_len: 200
password_confirm_labelstring-string.max_len: 200
tos_and_privacy_labelstring-string.max_len: 200
tos_confirmstring-string.max_len: 200
tos_link_textstring-string.max_len: 200
privacy_link_textstring-string.max_len: 200
save_button_textstring-string.max_len: 200
tos_confirm_andstring-string.max_len: 200

RegistrationUserScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
description_org_registerstring-string.max_len: 500
firstname_labelstring-string.max_len: 200
lastname_labelstring-string.max_len: 200
email_labelstring-string.max_len: 200
username_labelstring-string.max_len: 200
language_labelstring-string.max_len: 200
gender_labelstring-string.max_len: 200
password_labelstring-string.max_len: 200
password_confirm_labelstring-string.max_len: 200
tos_and_privacy_labelstring-string.max_len: 200
tos_confirmstring-string.max_len: 200
tos_link_textstring-string.max_len: 200
privacy_link_textstring-string.max_len: 200
next_button_textstring-string.max_len: 200
back_button_textstring-string.max_len: 200
tos_confirm_andstring-string.max_len: 200

SelectAccountScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
title_linking_processstring-string.max_len: 200
description_linking_processstring-string.max_len: 500
other_userstring-string.max_len: 500
session_state_activestring-string.max_len: 100
session_state_inactivestring-string.max_len: 100
user_must_be_member_of_orgstring-string.max_len: 500

SuccessLoginScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
auto_redirect_descriptionstringText to describe that auto redirect should happen after successful loginstring.max_len: 500
redirected_descriptionstringText to describe that the window can be closed after redirectstring.max_len: 100
next_button_textstring-string.max_len: 200

UsernameChangeDoneScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
next_button_textstring-string.max_len: 100

UsernameChangeScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
username_labelstring-string.max_len: 200
cancel_button_textstring-string.max_len: 100
next_button_textstring-string.max_len: 100

VerifyMFAOTPScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
code_labelstring-string.max_len: 200
next_button_textstring-string.max_len: 100

VerifyMFAU2FScreenText

FieldTypeDescriptionValidation
titlestring-string.max_len: 200
descriptionstring-string.max_len: 500
validate_token_textstring-string.max_len: 500
not_supportedstring-string.max_len: 500
error_retrystring-string.max_len: 500