ZITADEL Docs
APIsCore ResourcesV1Instance Objects

ExportData

POST
/export

Request Body

application/json

orgIds?org_ids
excludedOrgIds?excluded_org_ids
withPasswords?boolean
withOtp?boolean
responseOutput?boolean
localOutput?
s3Output?
gcsOutput?
timeout?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/export" \  -H "Content-Type: application/json" \  -d '{}'
{
  "orgs": [
    {
      "orgId": "string",
      "org": {
        "name": "string"
      },
      "domainPolicy": {
        "orgId": "string",
        "userLoginMustBeDomain": true,
        "validateOrgDomains": true,
        "smtpSenderAddressMatchesInstanceDomain": true
      },
      "labelPolicy": {
        "primaryColor": "string",
        "hideLoginNameSuffix": true,
        "warnColor": "string",
        "backgroundColor": "string",
        "fontColor": "string",
        "primaryColorDark": "string",
        "backgroundColorDark": "string",
        "warnColorDark": "string",
        "fontColorDark": "string",
        "disableWatermark": true,
        "themeMode": "THEME_MODE_UNSPECIFIED"
      },
      "lockoutPolicy": {
        "maxPasswordAttempts": 0,
        "maxOtpAttempts": 0
      },
      "loginPolicy": {
        "allowUsernamePassword": true,
        "allowRegister": true,
        "allowExternalIdp": true,
        "forceMfa": true,
        "passwordlessType": "PASSWORDLESS_TYPE_NOT_ALLOWED",
        "hidePasswordReset": true,
        "ignoreUnknownUsernames": true,
        "defaultRedirectUri": "string",
        "passwordCheckLifetime": "string",
        "externalLoginCheckLifetime": "string",
        "mfaInitSkipLifetime": "string",
        "secondFactorCheckLifetime": "string",
        "multiFactorCheckLifetime": "string",
        "secondFactors": [
          "SECOND_FACTOR_TYPE_UNSPECIFIED"
        ],
        "multiFactors": [
          "MULTI_FACTOR_TYPE_UNSPECIFIED"
        ],
        "idps": [
          {
            "idpId": "string",
            "ownerType": "IDP_OWNER_TYPE_UNSPECIFIED"
          }
        ],
        "allowDomainDiscovery": true,
        "disableLoginWithEmail": true,
        "disableLoginWithPhone": true,
        "forceMfaLocalOnly": true
      },
      "passwordComplexityPolicy": {
        "minLength": 0,
        "hasUppercase": true,
        "hasLowercase": true,
        "hasNumber": true,
        "hasSymbol": true
      },
      "privacyPolicy": {
        "tosLink": "string",
        "privacyLink": "string",
        "helpLink": "string",
        "supportEmail": "string",
        "docsLink": "string",
        "customLink": "string",
        "customLinkText": "string"
      },
      "projects": [
        {
          "projectId": "string",
          "project": {
            "name": "string",
            "projectRoleAssertion": true,
            "projectRoleCheck": true,
            "hasProjectCheck": true,
            "privateLabelingSetting": "PRIVATE_LABELING_SETTING_UNSPECIFIED"
          }
        }
      ],
      "projectRoles": [
        {
          "projectId": "string",
          "roleKey": "string",
          "displayName": "string",
          "group": "string"
        }
      ],
      "apiApps": [
        {
          "appId": "string",
          "app": {
            "projectId": "string",
            "name": "string",
            "authMethodType": "API_AUTH_METHOD_TYPE_BASIC"
          }
        }
      ],
      "oidcApps": [
        {
          "appId": "string",
          "app": {
            "projectId": "string",
            "name": "string",
            "redirectUris": [
              "string"
            ],
            "responseTypes": [
              "OIDC_RESPONSE_TYPE_CODE"
            ],
            "grantTypes": [
              "OIDC_GRANT_TYPE_AUTHORIZATION_CODE"
            ],
            "appType": "OIDC_APP_TYPE_WEB",
            "authMethodType": "OIDC_AUTH_METHOD_TYPE_BASIC",
            "postLogoutRedirectUris": [
              "string"
            ],
            "version": "OIDC_VERSION_1_0",
            "devMode": true,
            "accessTokenType": "OIDC_TOKEN_TYPE_BEARER",
            "accessTokenRoleAssertion": true,
            "idTokenRoleAssertion": true,
            "idTokenUserinfoAssertion": true,
            "clockSkew": "string",
            "additionalOrigins": [
              "string"
            ],
            "skipNativeAppSuccessPage": true,
            "backChannelLogoutUri": "string",
            "loginVersion": {
              "loginV1": {}
            }
          }
        }
      ],
      "humanUsers": [
        {
          "userId": "string",
          "user": {
            "userName": "string",
            "profile": {
              "firstName": "string",
              "lastName": "string",
              "nickName": "string",
              "displayName": "string",
              "preferredLanguage": "string",
              "gender": "GENDER_UNSPECIFIED"
            },
            "email": {
              "email": "string",
              "isEmailVerified": true
            },
            "phone": {
              "phone": "string",
              "isPhoneVerified": true
            },
            "password": "string",
            "hashedPassword": {
              "value": "string"
            },
            "passwordChangeRequired": true,
            "requestPasswordlessRegistration": true,
            "otpCode": "string",
            "idps": [
              {
                "configId": "string",
                "externalUserId": "string",
                "displayName": "string"
              }
            ],
            "recoveryCodes": [
              {
                "hash": "string"
              }
            ]
          },
          "state": "USER_STATE_UNSPECIFIED"
        }
      ],
      "machineUsers": [
        {
          "userId": "string",
          "user": {
            "userName": "string",
            "name": "string",
            "description": "string",
            "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER",
            "userId": "string"
          },
          "state": "USER_STATE_UNSPECIFIED"
        }
      ],
      "triggerActions": [
        {
          "flowType": "string",
          "triggerType": "string",
          "actionIds": [
            "string"
          ]
        }
      ],
      "actions": [
        {
          "actionId": "string",
          "action": {
            "name": "string",
            "script": "string",
            "timeout": "string",
            "allowedToFail": true
          }
        }
      ],
      "projectGrants": [
        {
          "grantId": "string",
          "projectGrant": {
            "projectId": "string",
            "grantedOrgId": "string",
            "roleKeys": [
              "string"
            ]
          }
        }
      ],
      "userGrants": [
        {
          "userId": "string",
          "projectId": "string",
          "projectGrantId": "string",
          "roleKeys": [
            "string"
          ]
        }
      ],
      "orgMembers": [
        {
          "userId": "string",
          "roles": [
            "string"
          ]
        }
      ],
      "projectMembers": [
        {
          "projectId": "string",
          "userId": "string",
          "roles": [
            "string"
          ]
        }
      ],
      "projectGrantMembers": [
        {
          "projectId": "string",
          "grantId": "string",
          "userId": "string",
          "roles": [
            "string"
          ]
        }
      ],
      "userMetadata": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "loginTexts": [
        {
          "language": "string",
          "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"
          }
        }
      ],
      "initMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "passwordResetMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "verifyEmailMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "verifyPhoneMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "domainClaimedMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "passwordlessRegistrationMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "oidcIdps": [
        {
          "idpId": "string",
          "idp": {
            "name": "string",
            "stylingType": "STYLING_TYPE_UNSPECIFIED",
            "clientId": "string",
            "clientSecret": "string",
            "issuer": "string",
            "scopes": [
              "string"
            ],
            "displayNameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED",
            "usernameMapping": "OIDC_MAPPING_FIELD_UNSPECIFIED",
            "autoRegister": true
          }
        }
      ],
      "jwtIdps": [
        {
          "idpId": "string",
          "idp": {
            "name": "string",
            "stylingType": "STYLING_TYPE_UNSPECIFIED",
            "jwtEndpoint": "string",
            "issuer": "string",
            "keysEndpoint": "string",
            "headerName": "string",
            "autoRegister": true
          }
        }
      ],
      "userLinks": [
        {
          "userId": "string",
          "idpId": "string",
          "idpName": "string",
          "providedUserId": "string",
          "providedUserName": "string",
          "idpType": "IDP_TYPE_UNSPECIFIED"
        }
      ],
      "domains": [
        {
          "orgId": "string",
          "details": {
            "sequence": 0,
            "creationDate": "1s",
            "changeDate": "1s",
            "resourceOwner": "string"
          },
          "domainName": "string",
          "isVerified": true,
          "isPrimary": true,
          "validationType": "DOMAIN_VALIDATION_TYPE_UNSPECIFIED"
        }
      ],
      "appKeys": [
        {
          "id": "string",
          "projectId": "string",
          "appId": "string",
          "clientId": "string",
          "type": "KEY_TYPE_UNSPECIFIED",
          "expirationDate": "1s",
          "publicKey": "string"
        }
      ],
      "machineKeys": [
        {
          "keyId": "string",
          "userId": "string",
          "type": "KEY_TYPE_UNSPECIFIED",
          "expirationDate": "1s",
          "publicKey": "string"
        }
      ],
      "verifySmsOtpMessages": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "verifyEmailOtpMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "inviteUserMessages": [
        {
          "language": "string",
          "title": "string",
          "preHeader": "string",
          "subject": "string",
          "greeting": "string",
          "text": "string",
          "buttonText": "string",
          "footerText": "string"
        }
      ],
      "orgState": "ORG_STATE_UNSPECIFIED"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?