Quick Start Guide

Authenticated User

Organization Objects

Instance Objects

ActivateEmailProvider ActivateFeatureLoginDefaultOrg ActivateLabelPolicy ActivateSMSProvider Add an Instance Trusted Domain Add instance Member AddAppleProvider AddAzureADProvider AddCustomDomainPolicy AddCustomOrgIAMPolicy AddEmailProviderHTTP AddEmailProviderSMTP AddGenericOAuthProvider AddGenericOIDCProvider AddGitHubEnterpriseServerProvider AddGitHubProvider AddGitLabProvider AddGitLabSelfHostedProvider AddGoogleProvider AddIDPToLoginPolicy AddJWTIDP AddJWTProvider AddLDAPProvider AddMultiFactorToLoginPolicy AddNotificationPolicy AddOIDCIDP AddOIDCSettings AddSAMLProvider AddSecondFactorToLoginPolicy AddSMSProviderHTTP AddSMSProviderTwilio DeactivateEmailProvider DeactivateIDP DeactivateSMSProvider DeleteProvider Deprecated: Activate SMTP Provider Deprecated: Add SMTP Configuration Deprecated: Deactivate SMTP Provider Deprecated: Get active SMTP Configuration Deprecated: Get SMTP provider configuration by its id Deprecated: List SMTP Configs Deprecated: Remove SMTP Configuration Deprecated: Test SMTP Provider Deprecated: Test SMTP Provider Deprecated: Update SMTP Configuration Deprecated: Update SMTP Password ExportData Get Default Organization Get My Instance Get Organization By ID GetAllowedLanguages GetCustomDomainClaimedMessageText GetCustomDomainPolicy GetCustomInitMessageText GetCustomInviteUserMessageText GetCustomLoginTexts GetCustomOrgIAMPolicy GetCustomPasswordChangeMessageText GetCustomPasswordlessRegistrationMessageText GetCustomPasswordResetMessageText GetCustomVerifyEmailMessageText GetCustomVerifyEmailOTPMessageText GetCustomVerifyPhoneMessageText GetCustomVerifySMSOTPMessageText GetDefaultDomainClaimedMessageText GetDefaultInitMessageText GetDefaultInviteUserMessageText GetDefaultLanguage GetDefaultLoginTexts GetDefaultPasswordChangeMessageText GetDefaultPasswordlessRegistrationMessageText GetDefaultPasswordResetMessageText GetDefaultPasswordResetMessageText GetDefaultVerifyEmailMessageText GetDefaultVerifyEmailOTPMessageText GetDefaultVerifyPhoneMessageText GetDefaultVerifySMSOTPMessageText GetDomainPolicy GetEmailProvider GetEmailProviderById GetFileSystemNotificationProvider GetIDPByID GetLabelPolicy GetLockoutPolicy GetLoginPolicy GetLogNotificationProvider GetNotificationPolicy GetOIDCSettings GetOrgIAMPolicy GetPasswordAgePolicy GetPasswordComplexityPolicy GetPreviewLabelPolicy GetPrivacyPolicy GetProviderByID GetRestrictions GetSecretGenerator GetSecurityPolicy GetSMSProvider GetSupportedLanguages Healthz ImportData Is Organization Unique List Instance Domains List instance Members List Instance Trusted Domains ListAggregateTypes ListEmailProviders ListEvents ListEventTypes ListFailedEvents ListIAMMemberRoles ListIDPs ListLoginPolicyIDPs ListLoginPolicyMultiFactors ListLoginPolicySecondFactors ListMilestones ListProviders ListSecretGenerators ListSMSProviders ListViews MigrateGenericOIDCProvider ReactivateIDP RegenerateSAMLProviderCertificate Remove an Instance Trusted Domain Remove IAM Member Remove Organization RemoveEmailProvider RemoveFailedEvent RemoveIDP RemoveIDPFromLoginPolicy RemoveLabelPolicyFont RemoveLabelPolicyIcon RemoveLabelPolicyIconDark RemoveLabelPolicyLogo RemoveLabelPolicyLogoDark RemoveMultiFactorFromLoginPolicy RemoveSecondFactorFromLoginPolicy RemoveSMSProvider ResetCustomDomainClaimedMessageTextToDefault ResetCustomDomainPolicyToDefault ResetCustomInitMessageTextToDefault ResetCustomInviteUserMessageTextToDefault ResetCustomLoginTextToDefault ResetCustomOrgIAMPolicyToDefault ResetCustomPasswordChangeMessageTextToDefault ResetCustomPasswordlessRegistrationMessageTextToDefault ResetCustomPasswordResetMessageTextToDefault ResetCustomVerifyEmailMessageTextToDefault ResetCustomVerifyEmailOTPMessageTextToDefault ResetCustomVerifyPhoneMessageTextToDefault ResetCustomVerifySMSOTPMessageTextToDefault Search Organizations SetCustomLoginText SetDefaultDomainClaimedMessageText SetDefaultInitMessageText SetDefaultInviteUserMessageText SetDefaultLanguage SetDefaultOrg SetDefaultPasswordChangeMessageText SetDefaultPasswordlessRegistrationMessageText SetDefaultPasswordResetMessageText SetDefaultVerifyEmailMessageText SetDefaultVerifyEmailOTPMessageText SetDefaultVerifyPhoneMessageText SetDefaultVerifySMSOTPMessageText SetRestrictions SetSecurityPolicy Setup Organization TestEmailProviderSMTP TestEmailProviderSMTPById Update instance Member UpdateAppleProvider UpdateAzureADProvider UpdateCustomDomainPolicy UpdateCustomOrgIAMPolicy UpdateDomainPolicy UpdateEmailProviderHTTP UpdateEmailProviderSMTP UpdateEmailProviderSMTPPassword UpdateGenericOAuthProvider UpdateGenericOIDCProvider UpdateGitHubEnterpriseServerProvider UpdateGitHubProvider UpdateGitLabProvider UpdateGitLabSelfHostedProvider UpdateGoogleProvider UpdateIDP UpdateIDPJWTConfig UpdateIDPOIDCConfig UpdateJWTProvider UpdateLabelPolicy UpdateLDAPProvider UpdateLockoutPolicy UpdateLoginPolicy UpdateNotificationPolicy UpdateOIDCSettings UpdateOrgIAMPolicy UpdatePasswordAgePolicy UpdatePasswordComplexityPolicy UpdatePrivacyPolicy UpdateSAMLProvider UpdateSecretGenerator UpdateSMSProviderHTTP UpdateSMSProviderTwilio UpdateSMSProviderTwilioToken

Instance Lifecycle

Migrate from v1 APIs to v2 APIs

gRPC Status Codes Rate Limits (Cloud)

APIsCore ResourcesV1

Admin API

API Reference for Admin

Terminology Update: We have streamlined our naming conventions to improve clarity. The term Admin has been replaced with Admin. To avoid breaking changes the APIs still make use of the old term. Both terms refer to the same underlying functionality.

Was this page helpful?

Verify Domain

Verify Domain: Deprecated: use [organization service v2 VerifyOrganizationDomain](/reference/api/org/zitadel.org.v2.OrganizationService.VerifyOrganizationDomain) instead. Make sure you have added the required ver...

ActivateEmailProvider

Explore the ActivateEmailProvider operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.