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 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
cancel_button_text | string | - | string.max_len: 100 |
login_button_text | string | - | string.max_len: 100 |
EmailVerificationScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
code_label | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 100 |
resend_button_text | string | - | string.max_len: 100 |
ExternalRegistrationUserOverviewScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
email_label | string | - | string.max_len: 200 |
username_label | string | - | string.max_len: 200 |
firstname_label | string | - | string.max_len: 200 |
lastname_label | string | - | string.max_len: 200 |
nickname_label | string | - | string.max_len: 200 |
language_label | string | - | string.max_len: 200 |
phone_label | string | - | string.max_len: 200 |
tos_and_privacy_label | string | - | string.max_len: 200 |
tos_confirm | string | - | string.max_len: 200 |
tos_link_text | string | - | string.max_len: 200 |
privacy_link_text | string | - | string.max_len: 200 |
back_button_text | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 200 |
privacy_confirm | string | - | string.max_len: 200 |
ExternalUserNotFoundScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
link_button_text | string | - | string.max_len: 100 |
auto_register_button_text | string | - | string.max_len: 100 |
tos_and_privacy_label | string | - | string.max_len: 200 |
tos_confirm | string | - | string.max_len: 200 |
tos_link_text | string | - | string.max_len: 200 |
privacy_link_text | string | - | string.max_len: 200 |
privacy_confirm | string | - | string.max_len: 200 |
FooterText
Field | Type | Description | Validation |
---|---|---|---|
tos | string | - | string.max_len: 200 |
privacy_policy | string | - | string.max_len: 200 |
help | string | - | string.max_len: 200 |
InitMFADoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
cancel_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
InitMFAOTPScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
description_otp | string | - | string.max_len: 500 |
secret_label | string | - | string.max_len: 200 |
code_label | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 100 |
cancel_button_text | string | - | string.max_len: 100 |
InitMFAPromptScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
otp_option | string | - | string.max_len: 200 |
u2f_option | string | - | string.max_len: 200 |
skip_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
InitMFAU2FScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
token_name_label | string | - | string.max_len: 200 |
not_supported | string | - | string.max_len: 500 |
register_token_button_text | string | - | string.max_len: 100 |
error_retry | string | - | string.max_len: 500 |
InitPasswordDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
cancel_button_text | string | - | string.max_len: 100 |
InitPasswordScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
code_label | string | - | string.max_len: 200 |
new_password_label | string | - | string.max_len: 200 |
new_password_confirm_label | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 100 |
resend_button_text | string | - | string.max_len: 100 |
InitializeUserDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
cancel_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
InitializeUserScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
code_label | string | - | string.max_len: 200 |
new_password_label | string | - | string.max_len: 200 |
new_password_confirm_label | string | - | string.max_len: 200 |
resend_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
LinkingUserDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
cancel_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
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 | - | |
external_registration_user_overview_text | ExternalRegistrationUserOverviewScreenText | - | |
is_default | bool | - |
LoginScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
title_linking_process | string | - | string.max_len: 200 |
description_linking_process | string | - | string.max_len: 500 |
user_must_be_member_of_org | string | - | string.max_len: 500 |
login_name_label | string | - | string.max_len: 200 |
register_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
external_user_description | string | - | string.max_len: 500 |
user_name_placeholder | string | - | string.max_len: 200 |
login_name_placeholder | string | - | string.max_len: 200 |
LogoutDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
login_button_text | string | - | string.max_len: 200 |
MFAProvidersText
Field | Type | Description | Validation |
---|---|---|---|
choose_other | string | - | string.max_len: 500 |
otp | string | - | string.max_len: 200 |
u2f | string | - | string.max_len: 200 |
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 | - | |
is_default | bool | - |
PasswordChangeDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
PasswordChangeScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
old_password_label | string | - | string.max_len: 200 |
new_password_label | string | - | string.max_len: 200 |
new_password_confirm_label | string | - | string.max_len: 200 |
cancel_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
PasswordResetDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
PasswordScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
password_label | string | - | string.max_len: 200 |
reset_link_text | string | - | string.max_len: 100 |
back_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
min_length | string | - | string.max_len: 100 |
has_uppercase | string | - | string.max_len: 100 |
has_lowercase | string | - | string.max_len: 100 |
has_number | string | - | string.max_len: 100 |
has_symbol | string | - | string.max_len: 100 |
confirmation | string | - | string.max_len: 100 |
PasswordlessPromptScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
description_init | string | - | string.max_len: 500 |
passwordless_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
skip_button_text | string | - | string.max_len: 100 |
PasswordlessRegistrationDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
cancel_button_text | string | - | string.max_len: 100 |
description_close | string | - | string.max_len: 100 |
PasswordlessRegistrationScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
token_name_label | string | - | string.max_len: 200 |
not_supported | string | - | string.max_len: 500 |
register_token_button_text | string | - | string.max_len: 100 |
error_retry | string | - | string.max_len: 500 |
PasswordlessScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
login_with_pw_button_text | string | - | string.max_len: 100 |
validate_token_button_text | string | - | string.max_len: 200 |
not_supported | string | - | string.max_len: 500 |
error_retry | string | - | string.max_len: 500 |
RegistrationOptionScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
user_name_button_text | string | - | string.max_len: 200 |
external_login_description | string | - | string.max_len: 500 |
login_button_text | string | - | string.max_len: 200 |
RegistrationOrgScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
orgname_label | string | - | string.max_len: 200 |
firstname_label | string | - | string.max_len: 200 |
lastname_label | string | - | string.max_len: 200 |
username_label | string | - | string.max_len: 200 |
email_label | string | - | string.max_len: 200 |
password_label | string | - | string.max_len: 200 |
password_confirm_label | string | - | string.max_len: 200 |
tos_and_privacy_label | string | - | string.max_len: 200 |
tos_confirm | string | - | string.max_len: 200 |
tos_link_text | string | - | string.max_len: 200 |
privacy_confirm | string | - | string.max_len: 200 |
privacy_link_text | string | - | string.max_len: 200 |
save_button_text | string | - | string.max_len: 200 |
RegistrationUserScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
description_org_register | string | - | string.max_len: 500 |
firstname_label | string | - | string.max_len: 200 |
lastname_label | string | - | string.max_len: 200 |
email_label | string | - | string.max_len: 200 |
username_label | string | - | string.max_len: 200 |
language_label | string | - | string.max_len: 200 |
gender_label | string | - | string.max_len: 200 |
password_label | string | - | string.max_len: 200 |
password_confirm_label | string | - | string.max_len: 200 |
tos_and_privacy_label | string | - | string.max_len: 200 |
tos_confirm | string | - | string.max_len: 200 |
tos_link_text | string | - | string.max_len: 200 |
privacy_confirm | string | - | string.max_len: 200 |
privacy_link_text | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 200 |
back_button_text | string | - | string.max_len: 200 |
SelectAccountScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
title_linking_process | string | - | string.max_len: 200 |
description_linking_process | string | - | string.max_len: 500 |
other_user | string | - | string.max_len: 500 |
session_state_active | string | - | string.max_len: 100 |
session_state_inactive | string | - | string.max_len: 100 |
user_must_be_member_of_org | string | - | string.max_len: 500 |
SuccessLoginScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
auto_redirect_description | string | Text to describe that auto redirect should happen after successful login | string.max_len: 500 |
redirected_description | string | Text to describe that the window can be closed after redirect | string.max_len: 100 |
next_button_text | string | - | string.max_len: 200 |
UsernameChangeDoneScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
next_button_text | string | - | string.max_len: 100 |
UsernameChangeScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
username_label | string | - | string.max_len: 200 |
cancel_button_text | string | - | string.max_len: 100 |
next_button_text | string | - | string.max_len: 100 |
VerifyMFAOTPScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
code_label | string | - | string.max_len: 200 |
next_button_text | string | - | string.max_len: 100 |
VerifyMFAU2FScreenText
Field | Type | Description | Validation |
---|---|---|---|
title | string | - | string.max_len: 200 |
description | string | - | string.max_len: 500 |
validate_token_text | string | - | string.max_len: 500 |
not_supported | string | - | string.max_len: 500 |
error_retry | string | - | string.max_len: 500 |