Quick Start Guide

Authenticated User

Organization Objects

ActivateCustomLabelPolicy Add Domain Add Organization Member Add Passkey Registration Link Add Project Grant Add Project Grant Member Add Project Member Add Project Role Add User Grant AddAppleProvider AddAzureADProvider AddCustomLabelPolicy AddCustomLockoutPolicy AddCustomLoginPolicy AddCustomNotificationPolicy AddCustomPasswordAgePolicy AddCustomPasswordComplexityPolicy AddCustomPrivacyPolicy AddGenericOAuthProvider AddGenericOIDCProvider AddGitHubEnterpriseServerProvider AddGitHubProvider AddGitLabProvider AddGitLabSelfHostedProvider AddGoogleProvider AddIDPToLoginPolicy AddJWTProvider AddLDAPProvider AddMultiFactorToLoginPolicy AddOrgJWTIDP AddOrgOIDCIDP AddSAMLProvider AddSecondFactorToLoginPolicy Bulk Add Project Role Bulk Delete Metadata Bulk Remove User Grants Bulk Set Organization Metadata Bulk Set User Metadata Change Project Grant Change Project Role Change user name Check for existing user ClearFlow Create a Personal-Access-Token (PAT)Create Application (API)Create Application (OIDC)Create Application (SAML)Create Application Key Create Key for service account Create Organization Create Project Create Secret for Service Account Create User (Human)Create User (Machine)Create/Import User (Human)CreateAction Deactivate Application Deactivate Organization Deactivate Project Deactivate Project Grant Deactivate User Deactivate User Deactivate User Grant DeactivateAction DeactivateOrgIDP Delete Application Key Delete Key for service account Delete Organization Delete Organization Metadata By Key Delete Passkey Delete Secret of Service Account Delete User Avatar (Human)Delete User Metadata By Key Delete User Metadata By Key DeleteAction DeleteProvider Generate Domain Verification Generate New API Client Secret Generate New OIDC Client Secret Get Application By ID Get Application Key By ID Get Granted Project By ID Get Organization By Domain Get Organization Metadata By Key Get Personal-Access-Token (PAT) by ID Get Project By ID Get Service account Key By ID Get User Authentication Factors (2FA/MFA)Get User by login name (globally)Get User Email (Human)Get User Grant By ID Get User Metadata By Key Get User Phone (Human)Get User Profile (Human)GetAction GetCustomDomainClaimedMessageText GetCustomInitMessageText GetCustomInviteUserMessageText GetCustomLoginTexts GetCustomPasswordChangeMessageText GetCustomPasswordlessRegistrationMessageText GetCustomPasswordResetMessageText GetCustomVerifyEmailMessageText GetCustomVerifyEmailOTPMessageText GetCustomVerifyPhoneMessageText GetCustomVerifySMSOTPMessageText GetDefaultDomainClaimedMessageText GetDefaultInitMessageText GetDefaultInviteUserMessageText GetDefaultLabelPolicy GetDefaultLockoutPolicy GetDefaultLoginPolicy GetDefaultLoginTexts GetDefaultNotificationPolicy GetDefaultPasswordAgePolicy GetDefaultPasswordChangeMessageText GetDefaultPasswordComplexityPolicy GetDefaultPasswordlessRegistrationMessageText GetDefaultPasswordResetMessageText GetDefaultPrivacyPolicy GetDefaultVerifyEmailMessageText GetDefaultVerifyEmailOTPMessageText GetDefaultVerifyPhoneMessageText GetDefaultVerifySMSOTPMessageText GetDomainPolicy GetFlow GetIAM GetLabelPolicy GetLockoutPolicy GetLoginPolicy GetMyOrg GetNotificationPolicy GetOIDCInformation GetOrgIAMPolicy GetOrgIDPByID GetPasswordAgePolicy GetPasswordComplexityPolicy GetPreviewLabelPolicy GetPrivacyPolicy GetProviderByID GetSupportedLanguages Healthz List Application Keys List Machine Keys List Organization Members List Personal-Access-Tokens (PATs)List Project Grant Members List Project Members List Social Logins List Zitadel Permissions ListActions ListAppChanges ListFlowTriggerTypes ListFlowTypes ListLoginPolicyIDPs ListLoginPolicyMultiFactors ListLoginPolicySecondFactors ListOrgChanges ListOrgIDPs ListOrgMemberRoles ListProjectChanges ListProjectGrantChanges ListProjectGrantMemberRoles ListProjectMemberRoles ListProviders ListUserChanges Lock User MigrateGenericOIDCProvider Project Grant By ID Reactivate Application Reactivate Organization Reactivate Project Reactivate Project Grant Reactivate User Grant ReactivateAction ReactivateOrgIDP RegenerateSAMLProviderCertificate Remove a Personal-Access-Token (PAT) by ID Remove Application Remove Domain Remove Multi-Factor OTP Remove Multi-Factor OTP Email Remove Multi-Factor OTP SMS Remove Multi-Factor U2F Remove Organization Member Remove Project Remove Project Grant Remove Project Grant Member Remove Project Member Remove Project Role Remove Social Login Remove User Grant Remove User Phone (Human)RemoveCustomLabelPolicyFont RemoveCustomLabelPolicyIcon RemoveCustomLabelPolicyIconDark RemoveCustomLabelPolicyLogo RemoveCustomLabelPolicyLogoDark RemoveIDPFromLoginPolicy RemoveMultiFactorFromLoginPolicy RemoveOrgIDP RemoveSecondFactorFromLoginPolicy Resend User Email Verification Resend User Initialization Email Resend User Phone Verification ResetCustomDomainClaimedMessageTextToDefault ResetCustomInitMessageTextToDefault ResetCustomInviteUserMessageTextToDefault ResetCustomLoginTextToDefault ResetCustomPasswordChangeMessageTextToDefault ResetCustomPasswordlessRegistrationMessageTextToDefault ResetCustomPasswordResetMessageTextToDefault ResetCustomVerifyEmailMessageTextToDefault ResetCustomVerifyEmailOTPMessageTextToDefault ResetCustomVerifyPhoneMessageTextToDefault ResetCustomVerifySMSOTPMessageTextToDefault ResetLabelPolicyToDefault ResetLockoutPolicyToDefault ResetLoginPolicyToDefault ResetNotificationPolicyToDefault ResetPasswordAgePolicyToDefault ResetPasswordComplexityPolicyToDefault ResetPrivacyPolicyToDefault Search Applications Search Domains Search Granted Project Search Granted Project Roles Search Organization Metadata Search Passkey authentication Search Project Search Project Grants Search Project Grants from Project Search Project Roles Search User Grants Search User Metadata Search Users Send Passkey Registration Link Send Reset Password Notification Set Human Initial Password Set Organization Metadata Set User Metadata Set User Password SetCustomDomainClaimedMessageCustomText SetCustomInitMessageText SetCustomInviteUserMessageCustomText SetCustomLoginText SetCustomPasswordChangeMessageCustomText SetCustomPasswordlessRegistrationMessageCustomText SetCustomPasswordResetMessageText SetCustomVerifyEmailMessageText SetCustomVerifyEmailOTPMessageText SetCustomVerifyPhoneMessageText SetCustomVerifySMSOTPMessageText SetPrimaryOrgDomain SetTriggerActions Unlock User Unlock User Update API Application Config Update Application Update OIDC Application Config Update Organization Update Organization Member Update Project Update Project Grant Member Update Project Member Update SAML Application Config Update Service Account Update User Email (Human)Update User Grant Update User Phone (Human)Update User Profile (Human)UpdateAction UpdateAppleProvider UpdateAzureADProvider UpdateCustomLabelPolicy UpdateCustomLockoutPolicy UpdateCustomLoginPolicy UpdateCustomNotificationPolicy UpdateCustomPasswordAgePolicy UpdateCustomPasswordComplexityPolicy UpdateCustomPrivacyPolicy UpdateGenericOAuthProvider UpdateGenericOIDCProvider UpdateGitHubEnterpriseServerProvider UpdateGitHubProvider UpdateGitLabProvider UpdateGitLabSelfHostedProvider UpdateGoogleProvider UpdateJWTProvider UpdateLDAPProvider UpdateOrgIDP UpdateOrgIDPJWTConfig UpdateOrgIDPOIDCConfig UpdateSAMLProvider User by ID Verify Domain

Instance Objects

Instance Lifecycle

Migrate from v1 APIs to v2 APIs

gRPC Status Codes Rate Limits (Cloud)

APIsCore ResourcesV1

Management API

API Reference for Management

Terminology Update: We have streamlined our naming conventions to improve clarity. The term Management has been replaced with Management. 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?

VerifyMyPhone

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

ActivateCustomLabelPolicy

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