Skip to main content

Set Default Login Text

PUT 

https://$CUSTOM-DOMAIN/management/v1/text/login/:language

Set the custom texts for the login and register UI of ZITADEL for the organization.

Request​

Path Parameters

    language stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Bodyrequired

    selectAccountText object
    titlestring
    descriptionstring
    titleLinkingProcessstring
    descriptionLinkingProcessstring
    otherUserstring
    sessionStateActivestring
    sessionStateInactivestring
    userMustBeMemberOfOrgstring
    loginText object
    titlestring
    descriptionstring
    titleLinkingProcessstring
    descriptionLinkingProcessstring
    userMustBeMemberOfOrgstring
    loginNameLabelstring
    registerButtonTextstring
    nextButtonTextstring
    externalUserDescriptionstring
    userNamePlaceholderstring
    loginNamePlaceholderstring
    passwordText object
    titlestring
    descriptionstring
    passwordLabelstring
    resetLinkTextstring
    backButtonTextstring
    nextButtonTextstring
    minLengthstring
    hasUppercasestring
    hasLowercasestring
    hasNumberstring
    hasSymbolstring
    confirmationstring
    usernameChangeText object
    titlestring
    descriptionstring
    usernameLabelstring
    cancelButtonTextstring
    nextButtonTextstring
    usernameChangeDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    initPasswordText object
    titlestring
    descriptionstring
    codeLabelstring
    newPasswordLabelstring
    newPasswordConfirmLabelstring
    nextButtonTextstring
    resendButtonTextstring
    initPasswordDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    cancelButtonTextstring
    emailVerificationText object
    titlestring
    descriptionstring
    codeLabelstring
    nextButtonTextstring
    resendButtonTextstring
    emailVerificationDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    cancelButtonTextstring
    loginButtonTextstring
    initializeUserText object
    titlestring
    descriptionstring
    codeLabelstring
    newPasswordLabelstring
    newPasswordConfirmLabelstring
    resendButtonTextstring
    nextButtonTextstring
    initializeDoneText object
    titlestring
    descriptionstring
    cancelButtonTextstring
    nextButtonTextstring
    initMfaPromptText object
    titlestring
    descriptionstring
    otpOptionstring
    u2fOptionstring
    skipButtonTextstring
    nextButtonTextstring
    initMfaOtpText object
    titlestring
    descriptionstring
    descriptionOtpstring
    secretLabelstring
    codeLabelstring
    nextButtonTextstring
    cancelButtonTextstring
    initMfaU2fText object
    titlestring
    descriptionstring
    tokenNameLabelstring
    notSupportedstring
    registerTokenButtonTextstring
    errorRetrystring
    initMfaDoneText object
    titlestring
    descriptionstring
    cancelButtonTextstring
    nextButtonTextstring
    mfaProvidersText object
    chooseOtherstring
    otpstring
    u2fstring
    verifyMfaOtpText object
    titlestring
    descriptionstring
    codeLabelstring
    nextButtonTextstring
    verifyMfaU2fText object
    titlestring
    descriptionstring
    validateTokenTextstring
    notSupportedstring
    errorRetrystring
    passwordlessText object
    titlestring
    descriptionstring
    loginWithPwButtonTextstring
    validateTokenButtonTextstring
    notSupportedstring
    errorRetrystring
    passwordChangeText object
    titlestring
    descriptionstring
    oldPasswordLabelstring
    newPasswordLabelstring
    newPasswordConfirmLabelstring
    cancelButtonTextstring
    nextButtonTextstring
    expiredDescriptionstring
    passwordChangeDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    passwordResetDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    registrationOptionText object
    titlestring
    descriptionstring
    userNameButtonTextstring
    externalLoginDescriptionstring
    loginButtonTextstring
    registrationUserText object
    titlestring
    descriptionstring
    descriptionOrgRegisterstring
    firstnameLabelstring
    lastnameLabelstring
    emailLabelstring
    usernameLabelstring
    languageLabelstring
    genderLabelstring
    passwordLabelstring
    passwordConfirmLabelstring
    tosAndPrivacyLabelstring
    tosConfirmstring
    tosLinkTextstring
    privacyConfirmstring
    privacyLinkTextstring
    nextButtonTextstring
    backButtonTextstring
    registrationOrgText object
    titlestring
    descriptionstring
    orgnameLabelstring
    firstnameLabelstring
    lastnameLabelstring
    usernameLabelstring
    emailLabelstring
    passwordLabelstring
    passwordConfirmLabelstring
    tosAndPrivacyLabelstring
    tosConfirmstring
    tosLinkTextstring
    privacyConfirmstring
    privacyLinkTextstring
    saveButtonTextstring
    linkingUserDoneText object
    titlestring
    descriptionstring
    cancelButtonTextstring
    nextButtonTextstring
    externalUserNotFoundText object
    titlestring
    descriptionstring
    linkButtonTextstring
    autoRegisterButtonTextstring
    tosAndPrivacyLabelstring
    tosConfirmstring
    tosLinkTextstring
    privacyLinkTextstring
    privacyConfirmstring
    successLoginText object
    titlestring
    autoRedirectDescriptionText to describe that auto-redirect should happen after successful login (string)
    redirectedDescriptionText to describe that the window can be closed after redirect (string)
    nextButtonTextstring
    logoutText object
    titlestring
    descriptionstring
    loginButtonTextstring
    footerText object
    tosstring
    privacyPolicystring
    helpstring
    supportEmailstring
    passwordlessPromptText object
    titlestring
    descriptionstring
    descriptionInitstring
    passwordlessButtonTextstring
    nextButtonTextstring
    skipButtonTextstring
    passwordlessRegistrationText object
    titlestring
    descriptionstring
    tokenNameLabelstring
    notSupportedstring
    registerTokenButtonTextstring
    errorRetrystring
    passwordlessRegistrationDoneText object
    titlestring
    descriptionstring
    nextButtonTextstring
    cancelButtonTextstring
    descriptionClosestring
    externalRegistrationUserOverviewText object
    titlestring
    descriptionstring
    emailLabelstring
    usernameLabelstring
    firstnameLabelstring
    lastnameLabelstring
    nicknameLabelstring
    languageLabelstring
    phoneLabelstring
    tosAndPrivacyLabelstring
    tosConfirmstring
    tosLinkTextstring
    privacyLinkTextstring
    backButtonTextstring
    nextButtonTextstring
    privacyConfirmstring
    linkingUserPromptText object
    titlestring
    descriptionstring
    linkButtonTextstring
    otherButtonTextstring

Responses​

A successful response.

Schema
    details object
    sequenceuint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    Example: 2
    creationDatedate-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDatedate-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwnerresource_owner is the organization an object belongs to (string)
    Example: 69629023906488334

Authorization: oauth2

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "selectAccountText": {
    "title": "string",
    "description": "string",
    "titleLinkingProcess": "string",
    "descriptionLinkingProcess": "string",
    "otherUser": "string",
    "sessionStateActive": "string",
    "sessionStateInactive": "string",
    "userMustBeMemberOfOrg": "string"
  },
  "loginText": {
    "title": "string",
    "description": "string",
    "titleLinkingProcess": "string",
    "descriptionLinkingProcess": "string",
    "userMustBeMemberOfOrg": "string",
    "loginNameLabel": "string",
    "registerButtonText": "string",
    "nextButtonText": "string",
    "externalUserDescription": "string",
    "userNamePlaceholder": "string",
    "loginNamePlaceholder": "string"
  },
  "passwordText": {
    "title": "string",
    "description": "string",
    "passwordLabel": "string",
    "resetLinkText": "string",
    "backButtonText": "string",
    "nextButtonText": "string",
    "minLength": "string",
    "hasUppercase": "string",
    "hasLowercase": "string",
    "hasNumber": "string",
    "hasSymbol": "string",
    "confirmation": "string"
  },
  "usernameChangeText": {
    "title": "string",
    "description": "string",
    "usernameLabel": "string",
    "cancelButtonText": "string",
    "nextButtonText": "string"
  },
  "usernameChangeDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string"
  },
  "initPasswordText": {
    "title": "string",
    "description": "string",
    "codeLabel": "string",
    "newPasswordLabel": "string",
    "newPasswordConfirmLabel": "string",
    "nextButtonText": "string",
    "resendButtonText": "string"
  },
  "initPasswordDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string",
    "cancelButtonText": "string"
  },
  "emailVerificationText": {
    "title": "string",
    "description": "string",
    "codeLabel": "string",
    "nextButtonText": "string",
    "resendButtonText": "string"
  },
  "emailVerificationDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string",
    "cancelButtonText": "string",
    "loginButtonText": "string"
  },
  "initializeUserText": {
    "title": "string",
    "description": "string",
    "codeLabel": "string",
    "newPasswordLabel": "string",
    "newPasswordConfirmLabel": "string",
    "resendButtonText": "string",
    "nextButtonText": "string"
  },
  "initializeDoneText": {
    "title": "string",
    "description": "string",
    "cancelButtonText": "string",
    "nextButtonText": "string"
  },
  "initMfaPromptText": {
    "title": "string",
    "description": "string",
    "otpOption": "string",
    "u2fOption": "string",
    "skipButtonText": "string",
    "nextButtonText": "string"
  },
  "initMfaOtpText": {
    "title": "string",
    "description": "string",
    "descriptionOtp": "string",
    "secretLabel": "string",
    "codeLabel": "string",
    "nextButtonText": "string",
    "cancelButtonText": "string"
  },
  "initMfaU2fText": {
    "title": "string",
    "description": "string",
    "tokenNameLabel": "string",
    "notSupported": "string",
    "registerTokenButtonText": "string",
    "errorRetry": "string"
  },
  "initMfaDoneText": {
    "title": "string",
    "description": "string",
    "cancelButtonText": "string",
    "nextButtonText": "string"
  },
  "mfaProvidersText": {
    "chooseOther": "string",
    "otp": "string",
    "u2f": "string"
  },
  "verifyMfaOtpText": {
    "title": "string",
    "description": "string",
    "codeLabel": "string",
    "nextButtonText": "string"
  },
  "verifyMfaU2fText": {
    "title": "string",
    "description": "string",
    "validateTokenText": "string",
    "notSupported": "string",
    "errorRetry": "string"
  },
  "passwordlessText": {
    "title": "string",
    "description": "string",
    "loginWithPwButtonText": "string",
    "validateTokenButtonText": "string",
    "notSupported": "string",
    "errorRetry": "string"
  },
  "passwordChangeText": {
    "title": "string",
    "description": "string",
    "oldPasswordLabel": "string",
    "newPasswordLabel": "string",
    "newPasswordConfirmLabel": "string",
    "cancelButtonText": "string",
    "nextButtonText": "string",
    "expiredDescription": "string"
  },
  "passwordChangeDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string"
  },
  "passwordResetDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string"
  },
  "registrationOptionText": {
    "title": "string",
    "description": "string",
    "userNameButtonText": "string",
    "externalLoginDescription": "string",
    "loginButtonText": "string"
  },
  "registrationUserText": {
    "title": "string",
    "description": "string",
    "descriptionOrgRegister": "string",
    "firstnameLabel": "string",
    "lastnameLabel": "string",
    "emailLabel": "string",
    "usernameLabel": "string",
    "languageLabel": "string",
    "genderLabel": "string",
    "passwordLabel": "string",
    "passwordConfirmLabel": "string",
    "tosAndPrivacyLabel": "string",
    "tosConfirm": "string",
    "tosLinkText": "string",
    "privacyConfirm": "string",
    "privacyLinkText": "string",
    "nextButtonText": "string",
    "backButtonText": "string"
  },
  "registrationOrgText": {
    "title": "string",
    "description": "string",
    "orgnameLabel": "string",
    "firstnameLabel": "string",
    "lastnameLabel": "string",
    "usernameLabel": "string",
    "emailLabel": "string",
    "passwordLabel": "string",
    "passwordConfirmLabel": "string",
    "tosAndPrivacyLabel": "string",
    "tosConfirm": "string",
    "tosLinkText": "string",
    "privacyConfirm": "string",
    "privacyLinkText": "string",
    "saveButtonText": "string"
  },
  "linkingUserDoneText": {
    "title": "string",
    "description": "string",
    "cancelButtonText": "string",
    "nextButtonText": "string"
  },
  "externalUserNotFoundText": {
    "title": "string",
    "description": "string",
    "linkButtonText": "string",
    "autoRegisterButtonText": "string",
    "tosAndPrivacyLabel": "string",
    "tosConfirm": "string",
    "tosLinkText": "string",
    "privacyLinkText": "string",
    "privacyConfirm": "string"
  },
  "successLoginText": {
    "title": "string",
    "autoRedirectDescription": "string",
    "redirectedDescription": "string",
    "nextButtonText": "string"
  },
  "logoutText": {
    "title": "string",
    "description": "string",
    "loginButtonText": "string"
  },
  "footerText": {
    "tos": "string",
    "privacyPolicy": "string",
    "help": "string",
    "supportEmail": "string"
  },
  "passwordlessPromptText": {
    "title": "string",
    "description": "string",
    "descriptionInit": "string",
    "passwordlessButtonText": "string",
    "nextButtonText": "string",
    "skipButtonText": "string"
  },
  "passwordlessRegistrationText": {
    "title": "string",
    "description": "string",
    "tokenNameLabel": "string",
    "notSupported": "string",
    "registerTokenButtonText": "string",
    "errorRetry": "string"
  },
  "passwordlessRegistrationDoneText": {
    "title": "string",
    "description": "string",
    "nextButtonText": "string",
    "cancelButtonText": "string",
    "descriptionClose": "string"
  },
  "externalRegistrationUserOverviewText": {
    "title": "string",
    "description": "string",
    "emailLabel": "string",
    "usernameLabel": "string",
    "firstnameLabel": "string",
    "lastnameLabel": "string",
    "nicknameLabel": "string",
    "languageLabel": "string",
    "phoneLabel": "string",
    "tosAndPrivacyLabel": "string",
    "tosConfirm": "string",
    "tosLinkText": "string",
    "privacyLinkText": "string",
    "backButtonText": "string",
    "nextButtonText": "string",
    "privacyConfirm": "string"
  },
  "linkingUserPromptText": {
    "title": "string",
    "description": "string",
    "linkButtonText": "string",
    "otherButtonText": "string"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!