Skip to main content

zitadel/admin.proto

This document reflects the state from API 1.0 (available from 20.04.2021)

AdminService

Healthz

rpc Healthz(HealthzRequest) HealthzResponse

Indicates if ZITADEL is running. It respondes as soon as ZITADEL started

GET: /healthz

GetSupportedLanguages

rpc GetSupportedLanguages(GetSupportedLanguagesRequest) GetSupportedLanguagesResponse

Returns the default languages

GET: /languages

SetDefaultLanguage

rpc SetDefaultLanguage(SetDefaultLanguageRequest) SetDefaultLanguageResponse

Set the default language

PUT: /languages/default/{language}

GetDefaultLanguage

rpc GetDefaultLanguage(GetDefaultLanguageRequest) GetDefaultLanguageResponse

Set the default language

GET: /languages/default

GetMyInstance

rpc GetMyInstance(GetMyInstanceRequest) GetMyInstanceResponse

Returns the details of the instance

GET: /instances/me

ListInstanceDomains

rpc ListInstanceDomains(ListInstanceDomainsRequest) ListInstanceDomainsResponse

Returns the domains of the instance

POST: /domains/_search

ListSecretGenerators

rpc ListSecretGenerators(ListSecretGeneratorsRequest) ListSecretGeneratorsResponse

Set the default language

POST: /secretgenerators/_search

GetSecretGenerator

rpc GetSecretGenerator(GetSecretGeneratorRequest) GetSecretGeneratorResponse

Get Secret Generator by type (e.g PasswordResetCode)

GET: /secretgenerators/{generator_type}

UpdateSecretGenerator

rpc UpdateSecretGenerator(UpdateSecretGeneratorRequest) UpdateSecretGeneratorResponse

Update secret generator configuration

PUT: /secretgenerators/{generator_type}

GetSMTPConfig

rpc GetSMTPConfig(GetSMTPConfigRequest) GetSMTPConfigResponse

Get system smtp configuration

GET: /smtp

AddSMTPConfig

rpc AddSMTPConfig(AddSMTPConfigRequest) AddSMTPConfigResponse

Add system smtp configuration

POST: /smtp

UpdateSMTPConfig

rpc UpdateSMTPConfig(UpdateSMTPConfigRequest) UpdateSMTPConfigResponse

Update system smtp configuration

PUT: /smtp

UpdateSMTPConfigPassword

rpc UpdateSMTPConfigPassword(UpdateSMTPConfigPasswordRequest) UpdateSMTPConfigPasswordResponse

Update system smtp configuration password for host

PUT: /smtp/password

RemoveSMTPConfig

rpc RemoveSMTPConfig(RemoveSMTPConfigRequest) RemoveSMTPConfigResponse

Remove system smtp configuration

DELETE: /smtp

ListSMSProviders

rpc ListSMSProviders(ListSMSProvidersRequest) ListSMSProvidersResponse

list sms provider configurations

POST: /sms/_search

GetSMSProvider

rpc GetSMSProvider(GetSMSProviderRequest) GetSMSProviderResponse

Get sms provider

GET: /sms/{id}

AddSMSProviderTwilio

rpc AddSMSProviderTwilio(AddSMSProviderTwilioRequest) AddSMSProviderTwilioResponse

Add twilio sms provider

POST: /sms/twilio

UpdateSMSProviderTwilio

rpc UpdateSMSProviderTwilio(UpdateSMSProviderTwilioRequest) UpdateSMSProviderTwilioResponse

Update twilio sms provider

PUT: /sms/twilio/{id}

UpdateSMSProviderTwilioToken

rpc UpdateSMSProviderTwilioToken(UpdateSMSProviderTwilioTokenRequest) UpdateSMSProviderTwilioTokenResponse

Update twilio sms provider token

PUT: /sms/twilio/{id}/token

ActivateSMSProvider

rpc ActivateSMSProvider(ActivateSMSProviderRequest) ActivateSMSProviderResponse

Activate sms provider

POST: /sms/{id}/_activate

DeactivateSMSProvider

rpc DeactivateSMSProvider(DeactivateSMSProviderRequest) DeactivateSMSProviderResponse

Deactivate sms provider

POST: /sms/{id}/_deactivate

RemoveSMSProvider

rpc RemoveSMSProvider(RemoveSMSProviderRequest) RemoveSMSProviderResponse

Remove sms provider token

DELETE: /sms/{id}

GetOIDCSettings

rpc GetOIDCSettings(GetOIDCSettingsRequest) GetOIDCSettingsResponse

Get OIDC settings (e.g token lifetimes, etc.)

GET: /settings/oidc

UpdateOIDCSettings

rpc UpdateOIDCSettings(UpdateOIDCSettingsRequest) UpdateOIDCSettingsResponse

Update oidc settings (e.g token lifetimes, etc)

PUT: /settings/oidc

GetFileSystemNotificationProvider

rpc GetFileSystemNotificationProvider(GetFileSystemNotificationProviderRequest) GetFileSystemNotificationProviderResponse

Get file system notification provider

GET: /notification/provider/file

GetLogNotificationProvider

rpc GetLogNotificationProvider(GetLogNotificationProviderRequest) GetLogNotificationProviderResponse

Get log notification provider

GET: /notification/provider/log

GetOrgByID

rpc GetOrgByID(GetOrgByIDRequest) GetOrgByIDResponse

Returns an organisation by id

GET: /orgs/{id}

IsOrgUnique

rpc IsOrgUnique(IsOrgUniqueRequest) IsOrgUniqueResponse

Checks whether an organisation exists by the given parameters

GET: /orgs/_is_unique

SetDefaultOrg

rpc SetDefaultOrg(SetDefaultOrgRequest) SetDefaultOrgResponse

Set the default org

PUT: /orgs/default/{org_id}

GetDefaultOrg

rpc GetDefaultOrg(GetDefaultOrgRequest) GetDefaultOrgResponse

Set the default org

GET: /orgs/default

ListOrgs

rpc ListOrgs(ListOrgsRequest) ListOrgsResponse

Returns all organisations matching the request all queries need to match (AND)

POST: /orgs/_search

SetUpOrg

rpc SetUpOrg(SetUpOrgRequest) SetUpOrgResponse

Creates a new org and user and adds the user to the orgs members as ORG_OWNER

POST: /orgs/_setup

GetIDPByID

rpc GetIDPByID(GetIDPByIDRequest) GetIDPByIDResponse

Returns a identity provider configuration of the IAM instance

GET: /idps/{id}

ListIDPs

rpc ListIDPs(ListIDPsRequest) ListIDPsResponse

Returns all identity provider configurations of the IAM instance

POST: /idps/_search

AddOIDCIDP

rpc AddOIDCIDP(AddOIDCIDPRequest) AddOIDCIDPResponse

Adds a new oidc identity provider configuration the IAM instance

POST: /idps/oidc

AddJWTIDP

rpc AddJWTIDP(AddJWTIDPRequest) AddJWTIDPResponse

Adds a new jwt identity provider configuration the IAM instance

POST: /idps/jwt

UpdateIDP

rpc UpdateIDP(UpdateIDPRequest) UpdateIDPResponse

Updates the specified idp all fields are updated. If no value is provided the field will be empty afterwards.

PUT: /idps/{idp_id}

DeactivateIDP

rpc DeactivateIDP(DeactivateIDPRequest) DeactivateIDPResponse

Sets the state of the idp to IDP_STATE_INACTIVE the state MUST be IDP_STATE_ACTIVE for this call

POST: /idps/{idp_id}/_deactivate

ReactivateIDP

rpc ReactivateIDP(ReactivateIDPRequest) ReactivateIDPResponse

Sets the state of the idp to IDP_STATE_ACTIVE the state MUST be IDP_STATE_INACTIVE for this call

POST: /idps/{idp_id}/_reactivate

RemoveIDP

rpc RemoveIDP(RemoveIDPRequest) RemoveIDPResponse

RemoveIDP deletes the IDP permanetly

DELETE: /idps/{idp_id}

UpdateIDPOIDCConfig

rpc UpdateIDPOIDCConfig(UpdateIDPOIDCConfigRequest) UpdateIDPOIDCConfigResponse

Updates the oidc configuration of the specified idp all fields are updated. If no value is provided the field will be empty afterwards.

PUT: /idps/{idp_id}/oidc_config

UpdateIDPJWTConfig

rpc UpdateIDPJWTConfig(UpdateIDPJWTConfigRequest) UpdateIDPJWTConfigResponse

Updates the jwt configuration of the specified idp all fields are updated. If no value is provided the field will be empty afterwards.

PUT: /idps/{idp_id}/jwt_config

GetOrgIAMPolicy

rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) GetOrgIAMPolicyResponse

deprecated: please use DomainPolicy instead Returns the Org IAM policy defined by the administrators of ZITADEL

GET: /policies/orgiam

UpdateOrgIAMPolicy

rpc UpdateOrgIAMPolicy(UpdateOrgIAMPolicyRequest) UpdateOrgIAMPolicyResponse

deprecated: please use DomainPolicy instead Updates the default OrgIAM policy. it impacts all organisations without a customised policy

PUT: /policies/orgiam

GetCustomOrgIAMPolicy

rpc GetCustomOrgIAMPolicy(GetCustomOrgIAMPolicyRequest) GetCustomOrgIAMPolicyResponse

deprecated: please use DomainPolicy instead Returns the customised policy or the default if not customised

GET: /orgs/{org_id}/policies/orgiam

AddCustomOrgIAMPolicy

rpc AddCustomOrgIAMPolicy(AddCustomOrgIAMPolicyRequest) AddCustomOrgIAMPolicyResponse

deprecated: please use DomainPolicy instead Defines a custom OrgIAM policy as specified

POST: /orgs/{org_id}/policies/orgiam

UpdateCustomOrgIAMPolicy

rpc UpdateCustomOrgIAMPolicy(UpdateCustomOrgIAMPolicyRequest) UpdateCustomOrgIAMPolicyResponse

deprecated: please use DomainPolicy instead Updates a custom OrgIAM policy as specified

PUT: /orgs/{org_id}/policies/orgiam

ResetCustomOrgIAMPolicyToDefault

rpc ResetCustomOrgIAMPolicyToDefault(ResetCustomOrgIAMPolicyToDefaultRequest) ResetCustomOrgIAMPolicyToDefaultResponse

deprecated: please use DomainPolicy instead Resets the org iam policy of the organisation to default ZITADEL will fallback to the default policy defined by the ZITADEL administrators

DELETE: /orgs/{org_id}/policies/orgiam

GetDomainPolicy

rpc GetDomainPolicy(GetDomainPolicyRequest) GetDomainPolicyResponse

Returns the Domain policy defined by the administrators of ZITADEL

GET: /policies/domain

UpdateDomainPolicy

rpc UpdateDomainPolicy(UpdateDomainPolicyRequest) UpdateDomainPolicyResponse

Updates the default Domain policy. it impacts all organisations without a customised policy

PUT: /policies/domain

GetCustomDomainPolicy

rpc GetCustomDomainPolicy(GetCustomDomainPolicyRequest) GetCustomDomainPolicyResponse

Returns the customised policy or the default if not customised

GET: /orgs/{org_id}/policies/domain

AddCustomDomainPolicy

rpc AddCustomDomainPolicy(AddCustomDomainPolicyRequest) AddCustomDomainPolicyResponse

Defines a custom Domain policy as specified

POST: /orgs/{org_id}/policies/domain

UpdateCustomDomainPolicy

rpc UpdateCustomDomainPolicy(UpdateCustomDomainPolicyRequest) UpdateCustomDomainPolicyResponse

Updates a custom Domain policy as specified

PUT: /orgs/{org_id}/policies/domain

ResetCustomDomainPolicyToDefault

rpc ResetCustomDomainPolicyToDefault(ResetCustomDomainPolicyToDefaultRequest) ResetCustomDomainPolicyToDefaultResponse

Resets the org iam policy of the organisation to default ZITADEL will fallback to the default policy defined by the ZITADEL administrators

DELETE: /orgs/{org_id}/policies/domain

GetLabelPolicy

rpc GetLabelPolicy(GetLabelPolicyRequest) GetLabelPolicyResponse

Returns the label policy defined by the administrators of ZITADEL

GET: /policies/label

GetPreviewLabelPolicy

rpc GetPreviewLabelPolicy(GetPreviewLabelPolicyRequest) GetPreviewLabelPolicyResponse

Returns the preview label policy defined by the administrators of ZITADEL

GET: /policies/label/_preview

UpdateLabelPolicy

rpc UpdateLabelPolicy(UpdateLabelPolicyRequest) UpdateLabelPolicyResponse

Updates the default label policy of ZITADEL it impacts all organisations without a customised policy

PUT: /policies/label

ActivateLabelPolicy

rpc ActivateLabelPolicy(ActivateLabelPolicyRequest) ActivateLabelPolicyResponse

Activates all changes of the label policy

POST: /policies/label/_activate

rpc RemoveLabelPolicyLogo(RemoveLabelPolicyLogoRequest) RemoveLabelPolicyLogoResponse

Removes the logo of the label policy

DELETE: /policies/label/logo

RemoveLabelPolicyLogoDark

rpc RemoveLabelPolicyLogoDark(RemoveLabelPolicyLogoDarkRequest) RemoveLabelPolicyLogoDarkResponse

Removes the logo dark of the label policy

DELETE: /policies/label/logo_dark

RemoveLabelPolicyIcon

rpc RemoveLabelPolicyIcon(RemoveLabelPolicyIconRequest) RemoveLabelPolicyIconResponse

Removes the icon of the label policy

DELETE: /policies/label/icon

RemoveLabelPolicyIconDark

rpc RemoveLabelPolicyIconDark(RemoveLabelPolicyIconDarkRequest) RemoveLabelPolicyIconDarkResponse

Removes the logo dark of the label policy

DELETE: /policies/label/icon_dark

RemoveLabelPolicyFont

rpc RemoveLabelPolicyFont(RemoveLabelPolicyFontRequest) RemoveLabelPolicyFontResponse

Removes the font of the label policy

DELETE: /policies/label/font

GetLoginPolicy

rpc GetLoginPolicy(GetLoginPolicyRequest) GetLoginPolicyResponse

Returns the login policy defined by the administrators of ZITADEL

GET: /policies/login

UpdateLoginPolicy

rpc UpdateLoginPolicy(UpdateLoginPolicyRequest) UpdateLoginPolicyResponse

Updates the default login policy of ZITADEL it impacts all organisations without a customised policy

PUT: /policies/login

ListLoginPolicyIDPs

rpc ListLoginPolicyIDPs(ListLoginPolicyIDPsRequest) ListLoginPolicyIDPsResponse

Returns the idps linked to the default login policy, defined by the administrators of ZITADEL

POST: /policies/login/idps/_search

AddIDPToLoginPolicy

rpc AddIDPToLoginPolicy(AddIDPToLoginPolicyRequest) AddIDPToLoginPolicyResponse

Adds the povided idp to the default login policy. It impacts all organisations without a customised policy

POST: /policies/login/idps

RemoveIDPFromLoginPolicy

rpc RemoveIDPFromLoginPolicy(RemoveIDPFromLoginPolicyRequest) RemoveIDPFromLoginPolicyResponse

Removes the povided idp from the default login policy. It impacts all organisations without a customised policy

DELETE: /policies/login/idps/{idp_id}

ListLoginPolicySecondFactors

rpc ListLoginPolicySecondFactors(ListLoginPolicySecondFactorsRequest) ListLoginPolicySecondFactorsResponse

Returns the available second factors defined by the administrators of ZITADEL

POST: /policies/login/second_factors/_search

AddSecondFactorToLoginPolicy

rpc AddSecondFactorToLoginPolicy(AddSecondFactorToLoginPolicyRequest) AddSecondFactorToLoginPolicyResponse

Adds a second factor to the default login policy. It impacts all organisations without a customised policy

POST: /policies/login/second_factors

RemoveSecondFactorFromLoginPolicy

rpc RemoveSecondFactorFromLoginPolicy(RemoveSecondFactorFromLoginPolicyRequest) RemoveSecondFactorFromLoginPolicyResponse

Removes a second factor from the default login policy. It impacts all organisations without a customised policy

DELETE: /policies/login/second_factors/{type}

ListLoginPolicyMultiFactors

rpc ListLoginPolicyMultiFactors(ListLoginPolicyMultiFactorsRequest) ListLoginPolicyMultiFactorsResponse

Returns the available multi factors defined by the administrators of ZITADEL

POST: /policies/login/multi_factors/_search

AddMultiFactorToLoginPolicy

rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) AddMultiFactorToLoginPolicyResponse

Adds a multi factor to the default login policy. It impacts all organisations without a customised policy

POST: /policies/login/multi_factors

RemoveMultiFactorFromLoginPolicy

rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) RemoveMultiFactorFromLoginPolicyResponse

Removes a multi factor from the default login policy. It impacts all organisations without a customised policy

DELETE: /policies/login/multi_factors/{type}

GetPasswordComplexityPolicy

rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) GetPasswordComplexityPolicyResponse

Returns the password complexity policy defined by the administrators of ZITADEL

GET: /policies/password/complexity

UpdatePasswordComplexityPolicy

rpc UpdatePasswordComplexityPolicy(UpdatePasswordComplexityPolicyRequest) UpdatePasswordComplexityPolicyResponse

Updates the default password complexity policy of ZITADEL it impacts all organisations without a customised policy

PUT: /policies/password/complexity

GetPasswordAgePolicy

rpc GetPasswordAgePolicy(GetPasswordAgePolicyRequest) GetPasswordAgePolicyResponse

Returns the password age policy defined by the administrators of ZITADEL

GET: /policies/password/age

UpdatePasswordAgePolicy

rpc UpdatePasswordAgePolicy(UpdatePasswordAgePolicyRequest) UpdatePasswordAgePolicyResponse

Updates the default password age policy of ZITADEL it impacts all organisations without a customised policy

PUT: /policies/password/age

GetLockoutPolicy

rpc GetLockoutPolicy(GetLockoutPolicyRequest) GetLockoutPolicyResponse

Returns the lockout policy defined by the administrators of ZITADEL

GET: /policies/lockout

UpdateLockoutPolicy

rpc UpdateLockoutPolicy(UpdateLockoutPolicyRequest) UpdateLockoutPolicyResponse

Updates the default lockout policy of ZITADEL it impacts all organisations without a customised policy

PUT: /policies/password/lockout

GetPrivacyPolicy

rpc GetPrivacyPolicy(GetPrivacyPolicyRequest) GetPrivacyPolicyResponse

Returns the privacy policy defined by the administrators of ZITADEL

GET: /policies/privacy

UpdatePrivacyPolicy

rpc UpdatePrivacyPolicy(UpdatePrivacyPolicyRequest) UpdatePrivacyPolicyResponse

Updates the default privacy policy of ZITADEL it impacts all organisations without a customised policy Variable {{.Lang}} can be set to have different links based on the language

PUT: /policies/privacy

GetDefaultInitMessageText

rpc GetDefaultInitMessageText(GetDefaultInitMessageTextRequest) GetDefaultInitMessageTextResponse

Returns the default text for initial message (translation file)

GET: /text/default/message/init/{language}

GetCustomInitMessageText

rpc GetCustomInitMessageText(GetCustomInitMessageTextRequest) GetCustomInitMessageTextResponse

Returns the custom text for initial message (overwritten in eventstore)

GET: /text/message/init/{language}

SetDefaultInitMessageText

rpc SetDefaultInitMessageText(SetDefaultInitMessageTextRequest) SetDefaultInitMessageTextResponse

Sets the default custom text for initial message it impacts all organisations without customized initial message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/init/{language}

ResetCustomInitMessageTextToDefault

rpc ResetCustomInitMessageTextToDefault(ResetCustomInitMessageTextToDefaultRequest) ResetCustomInitMessageTextToDefaultResponse

Removes the custom init message text of the system The default text from the translation file will trigger after

DELETE: /text/message/init/{language}

GetDefaultPasswordResetMessageText

rpc GetDefaultPasswordResetMessageText(GetDefaultPasswordResetMessageTextRequest) GetDefaultPasswordResetMessageTextResponse

Returns the default text for password reset message (translation file)

GET: /text/deafult/message/passwordreset/{language}

GetCustomPasswordResetMessageText

rpc GetCustomPasswordResetMessageText(GetCustomPasswordResetMessageTextRequest) GetCustomPasswordResetMessageTextResponse

Returns the custom text for password reset message (overwritten in eventstore)

GET: /text/message/passwordreset/{language}

SetDefaultPasswordResetMessageText

rpc SetDefaultPasswordResetMessageText(SetDefaultPasswordResetMessageTextRequest) SetDefaultPasswordResetMessageTextResponse

Sets the default custom text for password reset message it impacts all organisations without customized password reset message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/passwordreset/{language}

ResetCustomPasswordResetMessageTextToDefault

rpc ResetCustomPasswordResetMessageTextToDefault(ResetCustomPasswordResetMessageTextToDefaultRequest) ResetCustomPasswordResetMessageTextToDefaultResponse

Removes the custom password reset message text of the system The default text from the translation file will trigger after

DELETE: /text/message/verifyemail/{language}

GetDefaultVerifyEmailMessageText

rpc GetDefaultVerifyEmailMessageText(GetDefaultVerifyEmailMessageTextRequest) GetDefaultVerifyEmailMessageTextResponse

Returns the default text for verify email message (translation files)

GET: /text/default/message/verifyemail/{language}

GetCustomVerifyEmailMessageText

rpc GetCustomVerifyEmailMessageText(GetCustomVerifyEmailMessageTextRequest) GetCustomVerifyEmailMessageTextResponse

Returns the custom text for verify email message (overwritten in eventstore)

GET: /text/message/verifyemail/{language}

SetDefaultVerifyEmailMessageText

rpc SetDefaultVerifyEmailMessageText(SetDefaultVerifyEmailMessageTextRequest) SetDefaultVerifyEmailMessageTextResponse

Sets the default custom text for verify email message it impacts all organisations without customized verify email message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/verifyemail/{language}

ResetCustomVerifyEmailMessageTextToDefault

rpc ResetCustomVerifyEmailMessageTextToDefault(ResetCustomVerifyEmailMessageTextToDefaultRequest) ResetCustomVerifyEmailMessageTextToDefaultResponse

Removes the custom verify email message text of the system The default text from the translation file will trigger after

DELETE: /text/message/verifyemail/{language}

GetDefaultVerifyPhoneMessageText

rpc GetDefaultVerifyPhoneMessageText(GetDefaultVerifyPhoneMessageTextRequest) GetDefaultVerifyPhoneMessageTextResponse

Returns the default text for verify phone message (translation file)

GET: /text/default/message/verifyphone/{language}

GetCustomVerifyPhoneMessageText

rpc GetCustomVerifyPhoneMessageText(GetCustomVerifyPhoneMessageTextRequest) GetCustomVerifyPhoneMessageTextResponse

Returns the custom text for verify phone message

GET: /text/message/verifyphone/{language}

SetDefaultVerifyPhoneMessageText

rpc SetDefaultVerifyPhoneMessageText(SetDefaultVerifyPhoneMessageTextRequest) SetDefaultVerifyPhoneMessageTextResponse

Sets the default custom text for verify phone message it impacts all organisations without customized verify phone message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/verifyphone/{language}

ResetCustomVerifyPhoneMessageTextToDefault

rpc ResetCustomVerifyPhoneMessageTextToDefault(ResetCustomVerifyPhoneMessageTextToDefaultRequest) ResetCustomVerifyPhoneMessageTextToDefaultResponse

Removes the custom verify phone text of the system The default text from the translation file will trigger after

DELETE: /text/message/verifyphone/{language}

GetDefaultDomainClaimedMessageText

rpc GetDefaultDomainClaimedMessageText(GetDefaultDomainClaimedMessageTextRequest) GetDefaultDomainClaimedMessageTextResponse

Returns the default text for domain claimed message (translation file)

GET: /text/default/message/domainclaimed/{language}

GetCustomDomainClaimedMessageText

rpc GetCustomDomainClaimedMessageText(GetCustomDomainClaimedMessageTextRequest) GetCustomDomainClaimedMessageTextResponse

Returns the custom text for domain claimed message (overwritten in eventstore)

GET: /text/message/domainclaimed/{language}

SetDefaultDomainClaimedMessageText

rpc SetDefaultDomainClaimedMessageText(SetDefaultDomainClaimedMessageTextRequest) SetDefaultDomainClaimedMessageTextResponse

Sets the default custom text for domain claimed phone message it impacts all organisations without customized domain claimed message text The Following Variables can be used: {{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/domainclaimed/{language}

ResetCustomDomainClaimedMessageTextToDefault

rpc ResetCustomDomainClaimedMessageTextToDefault(ResetCustomDomainClaimedMessageTextToDefaultRequest) ResetCustomDomainClaimedMessageTextToDefaultResponse

Removes the custom domain claimed message text of the system The default text from the translation file will trigger after

DELETE: /text/message/domainclaimed/{language}

GetDefaultPasswordlessRegistrationMessageText

rpc GetDefaultPasswordlessRegistrationMessageText(GetDefaultPasswordlessRegistrationMessageTextRequest) GetDefaultPasswordlessRegistrationMessageTextResponse

Returns the default text for passwordless registration message (translation file)

GET: /text/default/message/passwordless_registration/{language}

GetCustomPasswordlessRegistrationMessageText

rpc GetCustomPasswordlessRegistrationMessageText(GetCustomPasswordlessRegistrationMessageTextRequest) GetCustomPasswordlessRegistrationMessageTextResponse

Returns the custom text for passwordless registration message (overwritten in eventstore)

GET: /text/message/passwordless_registration/{language}

SetDefaultPasswordlessRegistrationMessageText

rpc SetDefaultPasswordlessRegistrationMessageText(SetDefaultPasswordlessRegistrationMessageTextRequest) SetDefaultPasswordlessRegistrationMessageTextResponse

Sets the default custom text for passwordless registration message it impacts all organisations without customized passwordless registration message text The Following Variables can be used: {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

PUT: /text/message/passwordless_registration/{language}

ResetCustomPasswordlessRegistrationMessageTextToDefault

rpc ResetCustomPasswordlessRegistrationMessageTextToDefault(ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest) ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse

Removes the custom passwordless link message text of the system The default text from the translation file will trigger after

DELETE: /text/message/passwordless_registration/{language}

GetDefaultLoginTexts

rpc GetDefaultLoginTexts(GetDefaultLoginTextsRequest) GetDefaultLoginTextsResponse

Returns the default custom texts for login ui (translation file)

GET: /text/default/login/{language}

GetCustomLoginTexts

rpc GetCustomLoginTexts(GetCustomLoginTextsRequest) GetCustomLoginTextsResponse

Returns the custom texts for login ui

GET: /text/login/{language}

SetCustomLoginText

rpc SetCustomLoginText(SetCustomLoginTextsRequest) SetCustomLoginTextsResponse

Sets the custom text for login ui it impacts all organisations without customized login ui texts

PUT: /text/login/{language}

ResetCustomLoginTextToDefault

rpc ResetCustomLoginTextToDefault(ResetCustomLoginTextsToDefaultRequest) ResetCustomLoginTextsToDefaultResponse

Removes the custom texts for login ui it impacts all organisations without customized login ui texts The default text form translation file will trigger after

DELETE: /text/login/{language}

ListIAMMemberRoles

rpc ListIAMMemberRoles(ListIAMMemberRolesRequest) ListIAMMemberRolesResponse

Returns the IAM roles visible for the requested user

POST: /members/roles/_search

ListIAMMembers

rpc ListIAMMembers(ListIAMMembersRequest) ListIAMMembersResponse

Returns all members matching the request all queries need to match (ANDed)

POST: /members/_search

AddIAMMember

rpc AddIAMMember(AddIAMMemberRequest) AddIAMMemberResponse

Adds a user to the membership list of ZITADEL with the given roles undefined roles will be dropped

POST: /members

UpdateIAMMember

rpc UpdateIAMMember(UpdateIAMMemberRequest) UpdateIAMMemberResponse

Sets the given roles on a member. The member has only roles provided by this call

PUT: /members/{user_id}

RemoveIAMMember

rpc RemoveIAMMember(RemoveIAMMemberRequest) RemoveIAMMemberResponse

Removes the user from the membership list of ZITADEL

DELETE: /members/{user_id}

ListViews

rpc ListViews(ListViewsRequest) ListViewsResponse

Returns all stored read models of ZITADEL views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects

POST: /views/_search

ListFailedEvents

rpc ListFailedEvents(ListFailedEventsRequest) ListFailedEventsResponse

Returns event descriptions which cannot be processed. It's possible that some events need some retries. For example if the SMTP-API wasn't able to send an email at the first time

POST: /failedevents/_search

RemoveFailedEvent

rpc RemoveFailedEvent(RemoveFailedEventRequest) RemoveFailedEventResponse

Deletes the event from failed events view. the event is not removed from the change stream This call is usefull if the system was able to process the event later. e.g. if the second try of sending an email was successful. the first try produced a failed event. You can find out if it worked on the failure_count

DELETE: /failedevents/{database}/{view_name}/{failed_sequence}

ImportData

rpc ImportData(ImportDataRequest) ImportDataResponse

Imports data into instance and creates different objects

POST: /import

ExportData

rpc ExportData(ExportDataRequest) ExportDataResponse

Exports data from instance

POST: /export

Messages

ActivateLabelPolicyRequest

This is an empty request

ActivateLabelPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ActivateSMSProviderRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200

ActivateSMSProviderResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomDomainPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200
user_login_must_be_domainboolthe username has to end with the domain of it's organisation (uniqueness is organisation based)
validate_org_domainsbool-
smtp_sender_address_matches_instance_domainbool-

AddCustomDomainPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomOrgIAMPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200
user_login_must_be_domainboolthe username has to end with the domain of it's organisation (uniqueness is organisation based)

AddCustomOrgIAMPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddIAMMemberRequest

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
rolesrepeated stringif no roles provided the user won't have any rights

AddIAMMemberResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddIDPToLoginPolicyRequest

FieldTypeDescriptionValidation
idp_idstringId of the predefined idp configurationstring.min_len: 1
string.max_len: 200

AddIDPToLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddJWTIDPRequest

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
styling_typezitadel.idp.v1.IDPStylingType-enum.defined_only: true
jwt_endpointstring-string.min_len: 1
string.max_len: 200
issuerstring-string.min_len: 1
string.max_len: 200
keys_endpointstring-string.min_len: 1
string.max_len: 200
header_namestring-string.min_len: 1
string.max_len: 200
auto_registerbool-

AddJWTIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idp_idstring-

AddMultiFactorToLoginPolicyRequest

FieldTypeDescriptionValidation
typezitadel.policy.v1.MultiFactorType-enum.defined_only: true
enum.not_in: [0]

AddMultiFactorToLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddOIDCIDPRequest

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
styling_typezitadel.idp.v1.IDPStylingType-enum.defined_only: true
client_idstring-string.min_len: 1
string.max_len: 200
client_secretstring-string.min_len: 1
string.max_len: 200
issuerstring-string.min_len: 1
string.max_len: 200
scopesrepeated string-
display_name_mappingzitadel.idp.v1.OIDCMappingField-enum.defined_only: true
username_mappingzitadel.idp.v1.OIDCMappingField-enum.defined_only: true
auto_registerbool-

AddOIDCIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idp_idstring-

AddSMSProviderTwilioRequest

FieldTypeDescriptionValidation
sidstring-string.min_len: 1
string.max_len: 200
tokenstring-string.min_len: 1
string.max_len: 200
sender_numberstring-string.min_len: 1
string.max_len: 200

AddSMSProviderTwilioResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idstring-

AddSMTPConfigRequest

FieldTypeDescriptionValidation
sender_addressstring-string.min_len: 1
string.max_len: 200
sender_namestring-string.min_len: 1
string.max_len: 200
tlsbool-
hoststring-string.min_len: 1
string.max_len: 500
userstring-
passwordstring-

AddSMTPConfigResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddSecondFactorToLoginPolicyRequest

FieldTypeDescriptionValidation
typezitadel.policy.v1.SecondFactorType-enum.defined_only: true
enum.not_in: [0]

AddSecondFactorToLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DataOrg

FieldTypeDescriptionValidation
org_idstring-
orgzitadel.management.v1.AddOrgRequest-
domain_policyAddCustomDomainPolicyRequest-
label_policyzitadel.management.v1.AddCustomLabelPolicyRequest-
lockout_policyzitadel.management.v1.AddCustomLockoutPolicyRequest-
login_policyzitadel.management.v1.AddCustomLoginPolicyRequest-
password_complexity_policyzitadel.management.v1.AddCustomPasswordComplexityPolicyRequest-
privacy_policyzitadel.management.v1.AddCustomPrivacyPolicyRequest-
projectsrepeated zitadel.v1.v1.DataProject-
project_rolesrepeated zitadel.management.v1.AddProjectRoleRequest-
api_appsrepeated zitadel.v1.v1.DataAPIApplication-
oidc_appsrepeated zitadel.v1.v1.DataOIDCApplication-
human_usersrepeated zitadel.v1.v1.DataHumanUser-
machine_usersrepeated zitadel.v1.v1.DataMachineUser-
trigger_actionsrepeated zitadel.management.v1.SetTriggerActionsRequest-
actionsrepeated zitadel.v1.v1.DataAction-
project_grantsrepeated zitadel.v1.v1.DataProjectGrant-
user_grantsrepeated zitadel.management.v1.AddUserGrantRequest-
org_membersrepeated zitadel.management.v1.AddOrgMemberRequest-
project_membersrepeated zitadel.management.v1.AddProjectMemberRequest-
project_grant_membersrepeated zitadel.management.v1.AddProjectGrantMemberRequest-
user_metadatarepeated zitadel.management.v1.SetUserMetadataRequest-
login_textsrepeated zitadel.management.v1.SetCustomLoginTextsRequest-
init_messagesrepeated zitadel.management.v1.SetCustomInitMessageTextRequest-
password_reset_messagesrepeated zitadel.management.v1.SetCustomPasswordResetMessageTextRequest-
verify_email_messagesrepeated zitadel.management.v1.SetCustomVerifyEmailMessageTextRequest-
verify_phone_messagesrepeated zitadel.management.v1.SetCustomVerifyPhoneMessageTextRequest-
domain_claimed_messagesrepeated zitadel.management.v1.SetCustomDomainClaimedMessageTextRequest-
passwordless_registration_messagesrepeated zitadel.management.v1.SetCustomPasswordlessRegistrationMessageTextRequest-
oidc_idpsrepeated zitadel.v1.v1.DataOIDCIDP-
jwt_idpsrepeated zitadel.v1.v1.DataJWTIDP-
user_linksrepeated zitadel.idp.v1.IDPUserLink-
domainsrepeated zitadel.org.v1.Domain-

DeactivateIDPRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200

DeactivateIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateSMSProviderRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200

DeactivateSMSProviderResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ExportDataRequest

FieldTypeDescriptionValidation
org_idsrepeated string-
excluded_org_idsrepeated string-
with_passwordsbool-
with_otpbool-
response_outputbool-
local_outputExportDataRequest.LocalOutput-
s3_outputExportDataRequest.S3Output-
gcs_outputExportDataRequest.GCSOutput-
timeoutstring-

ExportDataRequest.GCSOutput

FieldTypeDescriptionValidation
bucketstring-
serviceaccount_jsonstring-
pathstring-

ExportDataRequest.LocalOutput

FieldTypeDescriptionValidation
pathstring-

ExportDataRequest.S3Output

FieldTypeDescriptionValidation
pathstring-
endpointstring-
access_key_idstring-
secret_access_keystring-
sslbool-
bucketstring-

ExportDataResponse

FieldTypeDescriptionValidation
orgsrepeated DataOrg-

FailedEvent

FieldTypeDescriptionValidation
databasestring-
view_namestring-
failed_sequenceuint64-
failure_countuint64-
error_messagestring-

GetCustomDomainClaimedMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomDomainClaimedMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomDomainPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200

GetCustomDomainPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.DomainPolicy-
is_defaultbooldeprecated: is_default is also defined in zitadel.policy.v1.DomainPolicy

GetCustomInitMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomInitMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomLoginTextsRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomLoginTextsResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.LoginCustomText-

GetCustomOrgIAMPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200

GetCustomOrgIAMPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.OrgIAMPolicy-
is_defaultbooldeprecated: is_default is also defined in zitadel.policy.v1.OrgIAMPolicy

GetCustomPasswordResetMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomPasswordResetMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomPasswordlessRegistrationMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomPasswordlessRegistrationMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomVerifyEmailMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomVerifyEmailMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomVerifyPhoneMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetCustomVerifyPhoneMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultDomainClaimedMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultDomainClaimedMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultInitMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultInitMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultLanguageRequest

This is an empty request

GetDefaultLanguageResponse

FieldTypeDescriptionValidation
languagestring-

GetDefaultLoginTextsRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultLoginTextsResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.LoginCustomText-

GetDefaultOrgRequest

This is an empty request

GetDefaultOrgResponse

FieldTypeDescriptionValidation
orgzitadel.org.v1.Org-

GetDefaultPasswordResetMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultPasswordResetMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultPasswordlessRegistrationMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultPasswordlessRegistrationMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultVerifyEmailMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultVerifyEmailMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultVerifyPhoneMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

GetDefaultVerifyPhoneMessageTextResponse

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDomainPolicyRequest

GetDomainPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.DomainPolicy-

GetFileSystemNotificationProviderRequest

This is an empty request

GetFileSystemNotificationProviderResponse

FieldTypeDescriptionValidation
providerzitadel.settings.v1.DebugNotificationProvider-

GetIDPByIDRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200

GetIDPByIDResponse

FieldTypeDescriptionValidation
idpzitadel.idp.v1.IDP-

GetLabelPolicyRequest

This is an empty request

GetLabelPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LabelPolicy-

GetLockoutPolicyRequest

This is an empty request

GetLockoutPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LockoutPolicy-

GetLogNotificationProviderRequest

This is an empty request

GetLogNotificationProviderResponse

FieldTypeDescriptionValidation
providerzitadel.settings.v1.DebugNotificationProvider-

GetLoginPolicyRequest

This is an empty request

GetLoginPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LoginPolicy-

GetMyInstanceRequest

This is an empty request

GetMyInstanceResponse

FieldTypeDescriptionValidation
instancezitadel.instance.v1.InstanceDetail-

GetOIDCSettingsRequest

This is an empty request

GetOIDCSettingsResponse

FieldTypeDescriptionValidation
settingszitadel.settings.v1.OIDCSettings-

GetOrgByIDRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200

GetOrgByIDResponse

FieldTypeDescriptionValidation
orgzitadel.org.v1.Org-

GetOrgIAMPolicyRequest

GetOrgIAMPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.OrgIAMPolicy-

GetPasswordAgePolicyRequest

This is an empty request

GetPasswordAgePolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PasswordAgePolicy-

GetPasswordComplexityPolicyRequest

GetPasswordComplexityPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PasswordComplexityPolicy-

GetPreviewLabelPolicyRequest

This is an empty request

GetPreviewLabelPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LabelPolicy-

GetPrivacyPolicyRequest

This is an empty request

GetPrivacyPolicyResponse

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PrivacyPolicy-

GetSMSProviderRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 100

GetSMSProviderResponse

FieldTypeDescriptionValidation
configzitadel.settings.v1.SMSProvider-

GetSMTPConfigRequest

This is an empty request

GetSMTPConfigResponse

FieldTypeDescriptionValidation
smtp_configzitadel.settings.v1.SMTPConfig-

GetSecretGeneratorRequest

FieldTypeDescriptionValidation
generator_typezitadel.settings.v1.SecretGeneratorType-enum.defined_only: true
enum.not_in: [0]

GetSecretGeneratorResponse

FieldTypeDescriptionValidation
secret_generatorzitadel.settings.v1.SecretGenerator-

GetSupportedLanguagesRequest

This is an empty request

GetSupportedLanguagesResponse

FieldTypeDescriptionValidation
languagesrepeated string-

HealthzRequest

This is an empty request

HealthzResponse

This is an empty response

IDPQuery

FieldTypeDescriptionValidation
oneof query.idp_id_queryzitadel.idp.v1.IDPIDQuery-
oneof query.idp_name_queryzitadel.idp.v1.IDPNameQuery-

ImportDataError

FieldTypeDescriptionValidation
typestring-
idstring-
messagestring-

ImportDataOrg

FieldTypeDescriptionValidation
orgsrepeated DataOrg-

ImportDataRequest

FieldTypeDescriptionValidation
oneof data.data_orgsImportDataOrg-
oneof data.data_orgsv1zitadel.v1.v1.ImportDataOrg-
oneof data.data_orgs_localImportDataRequest.LocalInput-
oneof data.data_orgsv1_localImportDataRequest.LocalInput-
oneof data.data_orgs_s3ImportDataRequest.S3Input-
oneof data.data_orgsv1_s3ImportDataRequest.S3Input-
oneof data.data_orgs_gcsImportDataRequest.GCSInput-
oneof data.data_orgsv1_gcsImportDataRequest.GCSInput-
timeoutstring-

ImportDataRequest.GCSInput

FieldTypeDescriptionValidation
bucketstring-
serviceaccount_jsonstring-
pathstring-

ImportDataRequest.LocalInput

FieldTypeDescriptionValidation
pathstring-

ImportDataRequest.S3Input

FieldTypeDescriptionValidation
pathstring-
endpointstring-
access_key_idstring-
secret_access_keystring-
sslbool-
bucketstring-

ImportDataResponse

FieldTypeDescriptionValidation
errorsrepeated ImportDataError-
successImportDataSuccess-

ImportDataSuccess

FieldTypeDescriptionValidation
orgsrepeated ImportDataSuccessOrg-

ImportDataSuccessOrg

FieldTypeDescriptionValidation
org_idstring-
project_idsrepeated string-
project_rolesrepeated string-
oidc_app_idsrepeated string-
api_app_idsrepeated string-
human_user_idsrepeated string-
machine_user_idsrepeated string-
action_idsrepeated string-
trigger_actionsrepeated zitadel.management.v1.SetTriggerActionsRequest-
project_grantsrepeated ImportDataSuccessProjectGrant-
user_grantsrepeated ImportDataSuccessUserGrant-
org_membersrepeated string-
project_membersrepeated ImportDataSuccessProjectMember-
project_grant_membersrepeated ImportDataSuccessProjectGrantMember-
oidc_ipdsrepeated string-
jwt_idpsrepeated string-
idp_linksrepeated string-
user_linksrepeated ImportDataSuccessUserLinks-
user_metadatarepeated ImportDataSuccessUserMetadata-
domainsrepeated string-

ImportDataSuccessProjectGrant

FieldTypeDescriptionValidation
grant_idstring-
project_idstring-
org_idstring-

ImportDataSuccessProjectGrantMember

FieldTypeDescriptionValidation
project_idstring-
grant_idstring-
user_idstring-

ImportDataSuccessProjectMember

FieldTypeDescriptionValidation
project_idstring-
user_idstring-

ImportDataSuccessUserGrant

FieldTypeDescriptionValidation
project_idstring-
user_idstring-
FieldTypeDescriptionValidation
user_idstring-
external_user_idstring-
display_namestring-
idp_idstring-

ImportDataSuccessUserMetadata

FieldTypeDescriptionValidation
user_idstring-
keystring-

IsOrgUniqueRequest

if name or domain is already in use, org is not unique at least one argument has to be provided

FieldTypeDescriptionValidation
namestring-string.max_len: 200
domainstring-string.max_len: 200

IsOrgUniqueResponse

FieldTypeDescriptionValidation
is_uniquebool-

ListFailedEventsRequest

This is an empty request

ListFailedEventsResponse

FieldTypeDescriptionValidation
resultrepeated FailedEventTODO: list details

ListIAMMemberRolesRequest

This is an empty request

ListIAMMemberRolesResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
rolesrepeated string-

ListIAMMembersRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.member.v1.SearchQuerycriterias the client is looking for

ListIAMMembersResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.member.v1.Member-

ListIDPsRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
sorting_columnzitadel.idp.v1.IDPFieldNamethe field the result is sorted
queriesrepeated IDPQuerycriterias the client is looking for

ListIDPsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
sorting_columnzitadel.idp.v1.IDPFieldName-
resultrepeated zitadel.idp.v1.IDP-

ListInstanceDomainsRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuery-
sorting_columnzitadel.instance.v1.DomainFieldNamethe field the result is sorted
queriesrepeated zitadel.instance.v1.DomainSearchQuerycriterias the client is looking for

ListInstanceDomainsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
sorting_columnzitadel.instance.v1.DomainFieldName-
resultrepeated zitadel.instance.v1.Domain-

ListLoginPolicyIDPsRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering

ListLoginPolicyIDPsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.idp.v1.IDPLoginPolicyLink-

ListLoginPolicyMultiFactorsRequest

This is an empty request

ListLoginPolicyMultiFactorsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.policy.v1.MultiFactorType-

ListLoginPolicySecondFactorsRequest

This is an empty request

ListLoginPolicySecondFactorsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.policy.v1.SecondFactorType-

ListOrgsRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
sorting_columnzitadel.org.v1.OrgFieldNamethe field the result is sorted
queriesrepeated zitadel.org.v1.OrgQuerycriterias the client is looking for

ListOrgsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
sorting_columnzitadel.org.v1.OrgFieldName-
resultrepeated zitadel.org.v1.Org-

ListSMSProvidersRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering

ListSMSProvidersResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.settings.v1.SMSProvider-

ListSecretGeneratorsRequest

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.settings.v1.SecretGeneratorQuerycriterias the client is looking for

ListSecretGeneratorsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.settings.v1.SecretGenerator-

ListViewsRequest

This is an empty request

ListViewsResponse

FieldTypeDescriptionValidation
resultrepeated ViewTODO: list details

ReactivateIDPRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200

ReactivateIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveFailedEventRequest

FieldTypeDescriptionValidation
databasestring-string.min_len: 1
string.max_len: 200
view_namestring-string.min_len: 1
string.max_len: 200
failed_sequenceuint64-

RemoveFailedEventResponse

This is an empty response

RemoveIAMMemberRequest

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200

RemoveIAMMemberResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveIDPFromLoginPolicyRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200

RemoveIDPFromLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveIDPRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200

RemoveIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveLabelPolicyFontRequest

This is an empty request

RemoveLabelPolicyFontResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveLabelPolicyIconDarkRequest

This is an empty request

RemoveLabelPolicyIconDarkResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveLabelPolicyIconRequest

This is an empty request

RemoveLabelPolicyIconResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveLabelPolicyLogoDarkRequest

This is an empty request

RemoveLabelPolicyLogoDarkResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveLabelPolicyLogoRequest

This is an empty request

RemoveLabelPolicyLogoResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveMultiFactorFromLoginPolicyRequest

FieldTypeDescriptionValidation
typezitadel.policy.v1.MultiFactorType-enum.defined_only: true
enum.not_in: [0]

RemoveMultiFactorFromLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveSMSProviderRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200

RemoveSMSProviderResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveSMTPConfigRequest

this is en empty request

RemoveSMTPConfigResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveSecondFactorFromLoginPolicyRequest

FieldTypeDescriptionValidation
typezitadel.policy.v1.SecondFactorType-enum.defined_only: true
enum.not_in: [0]

RemoveSecondFactorFromLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomDomainClaimedMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomDomainClaimedMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomDomainPolicyToDefaultRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200

ResetCustomDomainPolicyToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomInitMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomInitMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomLoginTextsToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomLoginTextsToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomOrgIAMPolicyToDefaultRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200

ResetCustomOrgIAMPolicyToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomPasswordResetMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomPasswordResetMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomVerifyEmailMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomVerifyEmailMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomVerifyPhoneMessageTextToDefaultRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200

ResetCustomVerifyPhoneMessageTextToDefaultResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomLoginTextsRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
select_account_textzitadel.text.v1.SelectAccountScreenText-
login_textzitadel.text.v1.LoginScreenText-
password_textzitadel.text.v1.PasswordScreenText-
username_change_textzitadel.text.v1.UsernameChangeScreenText-
username_change_done_textzitadel.text.v1.UsernameChangeDoneScreenText-
init_password_textzitadel.text.v1.InitPasswordScreenText-
init_password_done_textzitadel.text.v1.InitPasswordDoneScreenText-
email_verification_textzitadel.text.v1.EmailVerificationScreenText-
email_verification_done_textzitadel.text.v1.EmailVerificationDoneScreenText-
initialize_user_textzitadel.text.v1.InitializeUserScreenText-
initialize_done_textzitadel.text.v1.InitializeUserDoneScreenText-
init_mfa_prompt_textzitadel.text.v1.InitMFAPromptScreenText-
init_mfa_otp_textzitadel.text.v1.InitMFAOTPScreenText-
init_mfa_u2f_textzitadel.text.v1.InitMFAU2FScreenText-
init_mfa_done_textzitadel.text.v1.InitMFADoneScreenText-
mfa_providers_textzitadel.text.v1.MFAProvidersText-
verify_mfa_otp_textzitadel.text.v1.VerifyMFAOTPScreenText-
verify_mfa_u2f_textzitadel.text.v1.VerifyMFAU2FScreenText-
passwordless_textzitadel.text.v1.PasswordlessScreenText-
password_change_textzitadel.text.v1.PasswordChangeScreenText-
password_change_done_textzitadel.text.v1.PasswordChangeDoneScreenText-
password_reset_done_textzitadel.text.v1.PasswordResetDoneScreenText-
registration_option_textzitadel.text.v1.RegistrationOptionScreenText-
registration_user_textzitadel.text.v1.RegistrationUserScreenText-
registration_org_textzitadel.text.v1.RegistrationOrgScreenText-
linking_user_done_textzitadel.text.v1.LinkingUserDoneScreenText-
external_user_not_found_textzitadel.text.v1.ExternalUserNotFoundScreenText-
success_login_textzitadel.text.v1.SuccessLoginScreenText-
logout_textzitadel.text.v1.LogoutDoneScreenText-
footer_textzitadel.text.v1.FooterText-
passwordless_prompt_textzitadel.text.v1.PasswordlessPromptScreenText-
passwordless_registration_textzitadel.text.v1.PasswordlessRegistrationScreenText-
passwordless_registration_done_textzitadel.text.v1.PasswordlessRegistrationDoneScreenText-
external_registration_user_overview_textzitadel.text.v1.ExternalRegistrationUserOverviewScreenText-

SetCustomLoginTextsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultDomainClaimedMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 800
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultDomainClaimedMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultInitMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 1000
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultInitMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultLanguageRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 10

SetDefaultLanguageResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultOrgRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200

SetDefaultOrgResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultPasswordResetMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 800
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultPasswordResetMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultPasswordlessRegistrationMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 800
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultPasswordlessRegistrationMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultVerifyEmailMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 800
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultVerifyEmailMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetDefaultVerifyPhoneMessageTextRequest

FieldTypeDescriptionValidation
languagestring-string.min_len: 1
string.max_len: 200
titlestring-string.max_len: 200
pre_headerstring-string.max_len: 200
subjectstring-string.max_len: 200
greetingstring-string.max_len: 200
textstring-string.max_len: 800
button_textstring-string.max_len: 200
footer_textstring-string.max_len: 200

SetDefaultVerifyPhoneMessageTextResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetUpOrgRequest

FieldTypeDescriptionValidation
orgSetUpOrgRequest.Org-message.required: true
oneof user.humanSetUpOrgRequest.Humanoneof field for the user managing the organisation
rolesrepeated stringspecify Org Member Roles for the provided user (default is ORG_OWNER if roles are empty)

SetUpOrgRequest.Human

FieldTypeDescriptionValidation
user_namestring-string.min_len: 1
string.max_len: 200
profileSetUpOrgRequest.Human.Profile-message.required: true
emailSetUpOrgRequest.Human.Email-message.required: true
phoneSetUpOrgRequest.Human.Phone-
passwordstring-

SetUpOrgRequest.Human.Email

FieldTypeDescriptionValidation
emailstring-string.email: true
is_email_verifiedbool-

SetUpOrgRequest.Human.Phone

FieldTypeDescriptionValidation
phonestringhas to be a global numberstring.min_len: 1
string.max_len: 50
string.prefix: +
is_phone_verifiedbool-

SetUpOrgRequest.Human.Profile

FieldTypeDescriptionValidation
first_namestring-string.min_len: 1
string.max_len: 200
last_namestring-string.min_len: 1
string.max_len: 200
nick_namestring-string.max_len: 200
display_namestring-string.max_len: 200
preferred_languagestring-string.max_len: 10
genderzitadel.user.v1.Gender-

SetUpOrgRequest.Org

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
domainstring-string.max_len: 200

SetUpOrgResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
org_idstring-
user_idstring-

UpdateCustomDomainPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200
user_login_must_be_domainbool-
validate_org_domainsbool-
smtp_sender_address_matches_instance_domainbool-

UpdateCustomDomainPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomOrgIAMPolicyRequest

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200
user_login_must_be_domainbool-

UpdateCustomOrgIAMPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateDomainPolicyRequest

FieldTypeDescriptionValidation
user_login_must_be_domainbool-
validate_org_domainsbool-
smtp_sender_address_matches_instance_domainbool-

UpdateDomainPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateIAMMemberRequest

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
rolesrepeated stringif no roles provided the user won't have any rights

UpdateIAMMemberResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateIDPJWTConfigRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200
jwt_endpointstring-string.min_len: 1
string.max_len: 200
issuerstring-string.min_len: 1
string.max_len: 200
keys_endpointstring-string.min_len: 1
string.max_len: 200
header_namestring-string.min_len: 1
string.max_len: 200

UpdateIDPJWTConfigResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateIDPOIDCConfigRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200
issuerstring-string.min_len: 1
string.max_len: 200
client_idstring-string.min_len: 1
string.max_len: 200
client_secretstring-string.max_len: 200
scopesrepeated string-
display_name_mappingzitadel.idp.v1.OIDCMappingField-enum.defined_only: true
username_mappingzitadel.idp.v1.OIDCMappingField-enum.defined_only: true

UpdateIDPOIDCConfigResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateIDPRequest

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
styling_typezitadel.idp.v1.IDPStylingType-enum.defined_only: true
auto_registerbool-

UpdateIDPResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateLabelPolicyRequest

FieldTypeDescriptionValidation
primary_colorstring-string.max_len: 50
hide_login_name_suffixbool-
warn_colorstring-string.max_len: 50
background_colorstring-string.max_len: 50
font_colorstring-string.max_len: 50
primary_color_darkstring-string.max_len: 50
background_color_darkstring-string.max_len: 50
warn_color_darkstring-string.max_len: 50
font_color_darkstring-string.max_len: 50
disable_watermarkbool-

UpdateLabelPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateLockoutPolicyRequest

FieldTypeDescriptionValidation
max_password_attemptsuint32failed attempts until a user gets locked

UpdateLockoutPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateLoginPolicyRequest

FieldTypeDescriptionValidation
allow_username_passwordbool-
allow_registerbool-
allow_external_idpbool-
force_mfabool-
passwordless_typezitadel.policy.v1.PasswordlessType-enum.defined_only: true
hide_password_resetbool-
ignore_unknown_usernamesbool-
default_redirect_uristring-
password_check_lifetimegoogle.protobuf.Duration-
external_login_check_lifetimegoogle.protobuf.Duration-
mfa_init_skip_lifetimegoogle.protobuf.Duration-
second_factor_check_lifetimegoogle.protobuf.Duration-
multi_factor_check_lifetimegoogle.protobuf.Duration-

UpdateLoginPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOIDCSettingsRequest

FieldTypeDescriptionValidation
access_token_lifetimegoogle.protobuf.Duration-
id_token_lifetimegoogle.protobuf.Duration-
refresh_token_idle_expirationgoogle.protobuf.Duration-
refresh_token_expirationgoogle.protobuf.Duration-

UpdateOIDCSettingsResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgIAMPolicyRequest

FieldTypeDescriptionValidation
user_login_must_be_domainbool-

UpdateOrgIAMPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdatePasswordAgePolicyRequest

FieldTypeDescriptionValidation
max_age_daysuint32-
expire_warn_daysuint32-

UpdatePasswordAgePolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdatePasswordComplexityPolicyRequest

FieldTypeDescriptionValidation
min_lengthuint32-
has_uppercasebool-
has_lowercasebool-
has_numberbool-
has_symbolbool-

UpdatePasswordComplexityPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdatePrivacyPolicyRequest

FieldTypeDescriptionValidation
tos_linkstring-
privacy_linkstring-
help_linkstring-

UpdatePrivacyPolicyResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateSMSProviderTwilioRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
sidstring-string.min_len: 1
string.max_len: 200
sender_numberstring-string.min_len: 1
string.max_len: 200

UpdateSMSProviderTwilioResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateSMSProviderTwilioTokenRequest

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
tokenstring-string.min_len: 1
string.max_len: 200

UpdateSMSProviderTwilioTokenResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateSMTPConfigPasswordRequest

FieldTypeDescriptionValidation
passwordstring-

UpdateSMTPConfigPasswordResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateSMTPConfigRequest

FieldTypeDescriptionValidation
sender_addressstring-string.min_len: 1
string.max_len: 200
sender_namestring-string.min_len: 1
string.max_len: 200
tlsbool-
hoststring-string.min_len: 1
string.max_len: 500
userstring-

UpdateSMTPConfigResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateSecretGeneratorRequest

FieldTypeDescriptionValidation
generator_typezitadel.settings.v1.SecretGeneratorType-enum.defined_only: true
enum.not_in: [0]
lengthuint32-
expirygoogle.protobuf.Duration-
include_lower_lettersbool-
include_upper_lettersbool-
include_digitsbool-
include_symbolsbool-

UpdateSecretGeneratorResponse

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

View

FieldTypeDescriptionValidation
databasestring-
view_namestring-
processed_sequenceuint64-
event_timestampgoogle.protobuf.TimestampThe timestamp the event occured
last_successful_spooler_rungoogle.protobuf.Timestamp-