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

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

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

GET: /idps/{id}

ListIDPs​

rpc ListIDPs(ListIDPsRequest) ListIDPsResponse

Returns all identity provider configurations of the IAM

POST: /idps/_search

AddOIDCIDP​

rpc AddOIDCIDP(AddOIDCIDPRequest) AddOIDCIDPResponse

Adds a new oidc identity provider configuration the IAM

POST: /idps/oidc

AddJWTIDP​

rpc AddJWTIDP(AddJWTIDPRequest) AddJWTIDPResponse

Adds a new jwt identity provider configuration the IAM

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

GetDefaultFeatures​

rpc GetDefaultFeatures(GetDefaultFeaturesRequest) GetDefaultFeaturesResponse

GET: /features

SetDefaultFeatures​

rpc SetDefaultFeatures(SetDefaultFeaturesRequest) SetDefaultFeaturesResponse

PUT: /features

GetOrgFeatures​

rpc GetOrgFeatures(GetOrgFeaturesRequest) GetOrgFeaturesResponse

GET: /orgs/{org_id}/features

SetOrgFeatures​

rpc SetOrgFeatures(SetOrgFeaturesRequest) SetOrgFeaturesResponse

PUT: /orgs/{org_id}/features

ResetOrgFeatures​

rpc ResetOrgFeatures(ResetOrgFeaturesRequest) ResetOrgFeaturesResponse

DELETE: /orgs/{org_id}/features

GetOrgIAMPolicy​

rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) GetOrgIAMPolicyResponse

Returns the IAM policy defined by the administrators of ZITADEL

GET: /policies/orgiam

UpdateOrgIAMPolicy​

rpc UpdateOrgIAMPolicy(UpdateOrgIAMPolicyRequest) UpdateOrgIAMPolicyResponse

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

PUT: /policies/orgiam

GetCustomOrgIAMPolicy​

rpc GetCustomOrgIAMPolicy(GetCustomOrgIAMPolicyRequest) GetCustomOrgIAMPolicyResponse

Returns the customised policy or the default if not customised

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

AddCustomOrgIAMPolicy​

rpc AddCustomOrgIAMPolicy(AddCustomOrgIAMPolicyRequest) AddCustomOrgIAMPolicyResponse

Defines a custom ORGIAM policy as specified

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

UpdateCustomOrgIAMPolicy​

rpc UpdateCustomOrgIAMPolicy(UpdateCustomOrgIAMPolicyRequest) UpdateCustomOrgIAMPolicyResponse

Updates a custom ORGIAM policy as specified

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

ResetCustomOrgIAMPolicyToDefault​

rpc ResetCustomOrgIAMPolicyToDefault(ResetCustomOrgIAMPolicyToDefaultRequest) ResetCustomOrgIAMPolicyToDefaultResponse

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

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

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}

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}

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}

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}

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}

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}

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

ClearView​

rpc ClearView(ClearViewRequest) ClearViewResponse

Truncates the delta of the change stream be carefull with this function because ZITADEL has to recompute the deltas after they got cleared. Search requests will return wrong results until all deltas are recomputed

POST: /views/{database}/{view_name}

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}

Messages​

ActivateLabelPolicyRequest​

This is an empty request

ActivateLabelPolicyResponse​

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-

AddSecondFactorToLoginPolicyRequest​

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

AddSecondFactorToLoginPolicyResponse​

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ClearViewRequest​

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

ClearViewResponse​

This is an empty response

DeactivateIDPRequest​

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

DeactivateIDPResponse​

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

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-

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-

GetDefaultFeaturesRequest​

GetDefaultFeaturesResponse​

FieldTypeDescriptionValidation
featureszitadel.features.v1.Features-

GetDefaultInitMessageTextRequest​

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

GetDefaultInitMessageTextResponse​

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultLoginTextsRequest​

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

GetDefaultLoginTextsResponse​

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.LoginCustomText-

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-

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-

GetLoginPolicyRequest​

This is an empty request

GetLoginPolicyResponse​

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LoginPolicy-

GetOrgByIDRequest​

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

GetOrgByIDResponse​

FieldTypeDescriptionValidation
orgzitadel.org.v1.Org-

GetOrgFeaturesRequest​

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

GetOrgFeaturesResponse​

FieldTypeDescriptionValidation
featureszitadel.features.v1.Features-

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-

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-

IsOrgUniqueRequest​

if name or domain is already in use, org is not unique

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
domainstring-string.min_len: 1
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-

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-

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-

RemoveSecondFactorFromLoginPolicyRequest​

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

RemoveSecondFactorFromLoginPolicyResponse​

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-

ResetOrgFeaturesRequest​

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

ResetOrgFeaturesResponse​

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-

SetDefaultFeaturesRequest​

FieldTypeDescriptionValidation
tier_namestring-string.max_len: 200
descriptionstring-string.max_len: 200
audit_log_retentiongoogle.protobuf.Duration-duration.gte.seconds: 0
duration.gte.nanos: 0
login_policy_username_loginbool-
login_policy_registrationbool-
login_policy_idpbool-
login_policy_factorsbool-
login_policy_passwordlessbool-
password_complexity_policybool-
label_policybool-
custom_domainbool-
login_policy_password_resetbool-
label_policy_private_labelbool-
label_policy_watermarkbool-
custom_textbool-
privacy_policybool-
metadata_userbool-
custom_text_messagebool-
custom_text_loginbool-
lockout_policybool-
actionsbool-

SetDefaultFeaturesResponse​

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-

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-

SetOrgFeaturesRequest​

FieldTypeDescriptionValidation
org_idstring-string.min_len: 1
string.max_len: 200
tier_namestring-string.max_len: 200
descriptionstring-string.max_len: 200
statezitadel.features.v1.FeaturesState-
state_descriptionstring-string.max_len: 200
audit_log_retentiongoogle.protobuf.Duration-duration.gte.seconds: 0
duration.gte.nanos: 0
login_policy_username_loginbool-
login_policy_registrationbool-
login_policy_idpbool-
login_policy_factorsbool-
login_policy_passwordlessbool-
password_complexity_policybool-
label_policybool-
custom_domainbool-
login_policy_password_resetbool-
label_policy_private_labelbool-
label_policy_watermarkbool-
custom_textbool-
privacy_policybool-
metadata_userbool-
custom_text_messagebool-
custom_text_loginbool-
lockout_policybool-
actionsbool-

SetOrgFeaturesResponse​

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetUpOrgRequest​

FieldTypeDescriptionValidation
orgSetUpOrgRequest.Org-message.required: true
oneof user.humanSetUpOrgRequest.Humanoneof field for the user managing the organisation

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
emailstringTODO: check if no value is allowedstring.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-

UpdateCustomOrgIAMPolicyRequest​

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

UpdateCustomOrgIAMPolicyResponse​

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-

UpdateLoginPolicyResponse​

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-

UpdatePrivacyPolicyResponse​

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-