TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-05-03 20:30:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
zitadel/docs/docs/apis/proto/admin.md
Fabi ff9af1704f
feat: Extend oidc idp with oauth endpoints (#1980) 
* feat: add oauth attributes to oidc idp configuration

* feat: return idpconfig id on create idp

* feat: tests

* feat: descriptions

* feat: docs

* feat: tests
2021-07-06 14:39:48 +00:00

61 KiB
Raw Blame History

title
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

IsOrgUnique

rpc IsOrgUnique(IsOrgUniqueRequest) IsOrgUniqueResponse

Checks whether an organisation exists by the given parameters

GET: /orgs/_is_unique

GetOrgByID

rpc GetOrgByID(GetOrgByIDRequest) GetOrgByIDResponse

Returns an organisation by id

GET: /orgs/{id}

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

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

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

GetPasswordLockoutPolicy

rpc GetPasswordLockoutPolicy(GetPasswordLockoutPolicyRequest) GetPasswordLockoutPolicyResponse

Returns the password lockout policy defined by the administrators of ZITADEL

GET: /policies/password/lockout

UpdatePasswordLockoutPolicy

rpc UpdatePasswordLockoutPolicy(UpdatePasswordLockoutPolicyRequest) UpdatePasswordLockoutPolicyResponse

Updates the default password 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 custom text for initial message

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 custom text for password reset message

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 custom text for verify email message

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 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 custom text for domain claimed message

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 verify phone 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/verifyphone/{language}

GetDefaultLoginTexts

rpc GetDefaultLoginTexts(GetDefaultLoginTextsRequest) GetDefaultLoginTextsResponse

Returns the default custom texts for login ui

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}

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

Field Type Description Validation
details zitadel.v1.ObjectDetails -

AddCustomOrgIAMPolicyRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200
user_login_must_be_domain bool the username has to end with the domain of it's organisation (uniqueness is organisation based)

AddCustomOrgIAMPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

AddIAMMemberRequest

Field Type Description Validation
user_id string - string.min_len: 1
string.max_len: 200
roles repeated string if no roles provided the user won't have any rights

AddIAMMemberResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

AddIDPToLoginPolicyRequest

Field Type Description Validation
idp_id string Id of the predefined idp configuration string.min_len: 1
string.max_len: 200

AddIDPToLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

AddMultiFactorToLoginPolicyRequest

Field Type Description Validation
type zitadel.policy.v1.MultiFactorType - enum.defined_only: true
enum.not_in: [0]

AddMultiFactorToLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

AddOIDCIDPRequest

Field Type Description Validation
name string - string.min_len: 1
string.max_len: 200
styling_type zitadel.idp.v1.IDPStylingType - enum.defined_only: true
client_id string - string.min_len: 1
string.max_len: 200
client_secret string - string.min_len: 1
string.max_len: 200
issuer string Fill the issuer if the identity provider is oidc discovery compliant If the identity provider is only oauth2 compliant or does not serve a openid configuration, fill the authorization and token endpoint instead string.max_len: 200
scopes repeated string -
display_name_mapping zitadel.idp.v1.OIDCMappingField - enum.defined_only: true
username_mapping zitadel.idp.v1.OIDCMappingField - enum.defined_only: true
authorization_endpoint string If the identity provider does not serve an openid configuration, fill the authorization and token endpoint instead of the issuer string.max_len: 500
token_endpoint string If the identity provider does not serve an openid configuration, fill the authorization and token endpoint instead of the issuer string.max_len: 500

AddOIDCIDPResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -
idp_id string -

AddSecondFactorToLoginPolicyRequest

Field Type Description Validation
type zitadel.policy.v1.SecondFactorType - enum.defined_only: true
enum.not_in: [0]

AddSecondFactorToLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

ClearViewRequest

Field Type Description Validation
database string - string.min_len: 1
string.max_len: 200
view_name string - string.min_len: 1
string.max_len: 200

ClearViewResponse

This is an empty response

DeactivateIDPRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200

DeactivateIDPResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

FailedEvent

Field Type Description Validation
database string -
view_name string -
failed_sequence uint64 -
failure_count uint64 -
error_message string -

GetCustomLoginTextsRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetCustomLoginTextsResponse

Field Type Description Validation
custom_text zitadel.text.v1.LoginCustomText -

GetCustomOrgIAMPolicyRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200

GetCustomOrgIAMPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.OrgIAMPolicy -
is_default bool -

GetDefaultDomainClaimedMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultDomainClaimedMessageTextResponse

Field Type Description Validation
custom_text zitadel.text.v1.MessageCustomText -

GetDefaultFeaturesRequest

GetDefaultFeaturesResponse

Field Type Description Validation
features zitadel.features.v1.Features -

GetDefaultInitMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultInitMessageTextResponse

Field Type Description Validation
custom_text zitadel.text.v1.MessageCustomText -

GetDefaultLoginTextsRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultLoginTextsResponse

Field Type Description Validation
custom_text zitadel.text.v1.LoginCustomText -

GetDefaultPasswordResetMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultPasswordResetMessageTextResponse

Field Type Description Validation
custom_text zitadel.text.v1.MessageCustomText -

GetDefaultVerifyEmailMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultVerifyEmailMessageTextResponse

Field Type Description Validation
custom_text zitadel.text.v1.MessageCustomText -

GetDefaultVerifyPhoneMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200

GetDefaultVerifyPhoneMessageTextResponse

Field Type Description Validation
custom_text zitadel.text.v1.MessageCustomText -

GetIDPByIDRequest

Field Type Description Validation
id string - string.min_len: 1
string.max_len: 200

GetIDPByIDResponse

Field Type Description Validation
idp zitadel.idp.v1.IDP -

GetLabelPolicyRequest

This is an empty request

GetLabelPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.LabelPolicy -

GetLoginPolicyRequest

This is an empty request

GetLoginPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.LoginPolicy -

GetOrgByIDRequest

Field Type Description Validation
id string - string.min_len: 1
string.max_len: 200

GetOrgByIDResponse

Field Type Description Validation
org zitadel.org.v1.Org -

GetOrgFeaturesRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200

GetOrgFeaturesResponse

Field Type Description Validation
features zitadel.features.v1.Features -

GetOrgIAMPolicyRequest

GetOrgIAMPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.OrgIAMPolicy -

GetPasswordAgePolicyRequest

This is an empty request

GetPasswordAgePolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.PasswordAgePolicy -

GetPasswordComplexityPolicyRequest

GetPasswordComplexityPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.PasswordComplexityPolicy -

GetPasswordLockoutPolicyRequest

This is an empty request

GetPasswordLockoutPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.PasswordLockoutPolicy -

GetPreviewLabelPolicyRequest

This is an empty request

GetPreviewLabelPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.LabelPolicy -

GetPrivacyPolicyRequest

This is an empty request

GetPrivacyPolicyResponse

Field Type Description Validation
policy zitadel.policy.v1.PrivacyPolicy -

HealthzRequest

This is an empty request

HealthzResponse

This is an empty response

IDPQuery

Field Type Description Validation
oneof query.idp_id_query zitadel.idp.v1.IDPIDQuery -
oneof query.idp_name_query zitadel.idp.v1.IDPNameQuery -

IsOrgUniqueRequest

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

Field Type Description Validation
name string - string.min_len: 1
string.max_len: 200
domain string - string.min_len: 1
string.max_len: 200

IsOrgUniqueResponse

Field Type Description Validation
is_unique bool -

ListFailedEventsRequest

This is an empty request

ListFailedEventsResponse

Field Type Description Validation
result repeated FailedEvent TODO: list details

ListIAMMemberRolesRequest

This is an empty request

ListIAMMemberRolesResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
roles repeated string -

ListIAMMembersRequest

Field Type Description Validation
query zitadel.v1.ListQuery list limitations and ordering
queries repeated zitadel.member.v1.SearchQuery criterias the client is looking for

ListIAMMembersResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
result repeated zitadel.member.v1.Member -

ListIDPsRequest

Field Type Description Validation
query zitadel.v1.ListQuery list limitations and ordering
sorting_column zitadel.idp.v1.IDPFieldName the field the result is sorted
queries repeated IDPQuery criterias the client is looking for

ListIDPsResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
sorting_column zitadel.idp.v1.IDPFieldName -
result repeated zitadel.idp.v1.IDP -

ListLoginPolicyIDPsRequest

Field Type Description Validation
query zitadel.v1.ListQuery list limitations and ordering

ListLoginPolicyIDPsResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
result repeated zitadel.idp.v1.IDPLoginPolicyLink -

ListLoginPolicyMultiFactorsRequest

This is an empty request

ListLoginPolicyMultiFactorsResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
result repeated zitadel.policy.v1.MultiFactorType -

ListLoginPolicySecondFactorsRequest

This is an empty request

ListLoginPolicySecondFactorsResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
result repeated zitadel.policy.v1.SecondFactorType -

ListOrgsRequest

Field Type Description Validation
query zitadel.v1.ListQuery list limitations and ordering
sorting_column zitadel.org.v1.OrgFieldName the field the result is sorted
queries repeated zitadel.org.v1.OrgQuery criterias the client is looking for

ListOrgsResponse

Field Type Description Validation
details zitadel.v1.ListDetails -
sorting_column zitadel.org.v1.OrgFieldName -
result repeated zitadel.org.v1.Org -

ListViewsRequest

This is an empty request

ListViewsResponse

Field Type Description Validation
result repeated View TODO: list details

ReactivateIDPRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200

ReactivateIDPResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveFailedEventRequest

Field Type Description Validation
database string - string.min_len: 1
string.max_len: 200
view_name string - string.min_len: 1
string.max_len: 200
failed_sequence uint64 -

RemoveFailedEventResponse

This is an empty response

RemoveIAMMemberRequest

Field Type Description Validation
user_id string - string.min_len: 1
string.max_len: 200

RemoveIAMMemberResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveIDPFromLoginPolicyRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200

RemoveIDPFromLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveIDPRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200

RemoveIDPResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveLabelPolicyFontRequest

This is an empty request

RemoveLabelPolicyFontResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveLabelPolicyIconDarkRequest

This is an empty request

RemoveLabelPolicyIconDarkResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveLabelPolicyIconRequest

This is an empty request

RemoveLabelPolicyIconResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveLabelPolicyLogoDarkRequest

This is an empty request

RemoveLabelPolicyLogoDarkResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveLabelPolicyLogoRequest

This is an empty request

RemoveLabelPolicyLogoResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveMultiFactorFromLoginPolicyRequest

Field Type Description Validation
type zitadel.policy.v1.MultiFactorType - enum.defined_only: true
enum.not_in: [0]

RemoveMultiFactorFromLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

RemoveSecondFactorFromLoginPolicyRequest

Field Type Description Validation
type zitadel.policy.v1.SecondFactorType - enum.defined_only: true
enum.not_in: [0]

RemoveSecondFactorFromLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

ResetCustomOrgIAMPolicyToDefaultRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200

ResetCustomOrgIAMPolicyToDefaultResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

ResetOrgFeaturesRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200

ResetOrgFeaturesResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetCustomLoginTextsRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
select_account_text zitadel.text.v1.SelectAccountScreenText -
login_text zitadel.text.v1.LoginScreenText -
password_text zitadel.text.v1.PasswordScreenText -
username_change_text zitadel.text.v1.UsernameChangeScreenText -
username_change_done_text zitadel.text.v1.UsernameChangeDoneScreenText -
init_password_text zitadel.text.v1.InitPasswordScreenText -
init_password_done_text zitadel.text.v1.InitPasswordDoneScreenText -
email_verification_text zitadel.text.v1.EmailVerificationScreenText -
email_verification_done_text zitadel.text.v1.EmailVerificationDoneScreenText -
initialize_user_text zitadel.text.v1.InitializeUserScreenText -
initialize_done_text zitadel.text.v1.InitializeUserDoneScreenText -
init_mfa_prompt_text zitadel.text.v1.InitMFAPromptScreenText -
init_mfa_otp_text zitadel.text.v1.InitMFAOTPScreenText -
init_mfa_u2f_text zitadel.text.v1.InitMFAU2FScreenText -
init_mfa_done_text zitadel.text.v1.InitMFADoneScreenText -
mfa_providers_text zitadel.text.v1.MFAProvidersText -
verify_mfa_otp_text zitadel.text.v1.VerifyMFAOTPScreenText -
verify_mfa_u2f_text zitadel.text.v1.VerifyMFAU2FScreenText -
passwordless_text zitadel.text.v1.PasswordlessScreenText -
password_change_text zitadel.text.v1.PasswordChangeScreenText -
password_change_done_text zitadel.text.v1.PasswordChangeDoneScreenText -
password_reset_done_text zitadel.text.v1.PasswordResetDoneScreenText -
registration_option_text zitadel.text.v1.RegistrationOptionScreenText -
registration_user_text zitadel.text.v1.RegistrationUserScreenText -
registration_org_text zitadel.text.v1.RegistrationOrgScreenText -
linking_user_done_text zitadel.text.v1.LinkingUserDoneScreenText -
external_user_not_found_text zitadel.text.v1.ExternalUserNotFoundScreenText -
success_login_text zitadel.text.v1.SuccessLoginScreenText -
logout_text zitadel.text.v1.LogoutDoneScreenText -
footer_text zitadel.text.v1.FooterText -

SetCustomLoginTextsResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultDomainClaimedMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
title string - string.max_len: 200
pre_header string - string.max_len: 200
subject string - string.max_len: 200
greeting string - string.max_len: 200
text string - string.max_len: 800
button_text string - string.max_len: 200
footer_text string - string.max_len: 200

SetDefaultDomainClaimedMessageTextResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultFeaturesRequest

Field Type Description Validation
tier_name string - string.max_len: 200
description string - string.max_len: 200
audit_log_retention google.protobuf.Duration - duration.gte.seconds: 0
duration.gte.nanos: 0
login_policy_username_login bool -
login_policy_registration bool -
login_policy_idp bool -
login_policy_factors bool -
login_policy_passwordless bool -
password_complexity_policy bool -
label_policy bool -
custom_domain bool -
login_policy_password_reset bool -
label_policy_private_label bool -
label_policy_watermark bool -
custom_text bool -
privacy_policy bool -

SetDefaultFeaturesResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultInitMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
title string - string.max_len: 200
pre_header string - string.max_len: 200
subject string - string.max_len: 200
greeting string - string.max_len: 200
text string - string.max_len: 1000
button_text string - string.max_len: 200
footer_text string - string.max_len: 200

SetDefaultInitMessageTextResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultPasswordResetMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
title string - string.max_len: 200
pre_header string - string.max_len: 200
subject string - string.max_len: 200
greeting string - string.max_len: 200
text string - string.max_len: 800
button_text string - string.max_len: 200
footer_text string - string.max_len: 200

SetDefaultPasswordResetMessageTextResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultVerifyEmailMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
title string - string.max_len: 200
pre_header string - string.max_len: 200
subject string - string.max_len: 200
greeting string - string.max_len: 200
text string - string.max_len: 800
button_text string - string.max_len: 200
footer_text string - string.max_len: 200

SetDefaultVerifyEmailMessageTextResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetDefaultVerifyPhoneMessageTextRequest

Field Type Description Validation
language string - string.min_len: 1
string.max_len: 200
title string - string.max_len: 200
pre_header string - string.max_len: 200
subject string - string.max_len: 200
greeting string - string.max_len: 200
text string - string.max_len: 800
button_text string - string.max_len: 200
footer_text string - string.max_len: 200

SetDefaultVerifyPhoneMessageTextResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetOrgFeaturesRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200
tier_name string - string.max_len: 200
description string - string.max_len: 200
state zitadel.features.v1.FeaturesState -
state_description string - string.max_len: 200
audit_log_retention google.protobuf.Duration - duration.gte.seconds: 0
duration.gte.nanos: 0
login_policy_username_login bool -
login_policy_registration bool -
login_policy_idp bool -
login_policy_factors bool -
login_policy_passwordless bool -
password_complexity_policy bool -
label_policy bool -
custom_domain bool -
login_policy_password_reset bool -
label_policy_private_label bool -
label_policy_watermark bool -
custom_text bool -
privacy_policy bool -

SetOrgFeaturesResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

SetUpOrgRequest

Field Type Description Validation
org SetUpOrgRequest.Org - message.required: true
oneof user.human SetUpOrgRequest.Human oneof field for the user managing the organisation

SetUpOrgRequest.Human

Field Type Description Validation
user_name string - string.min_len: 1
string.max_len: 200
profile SetUpOrgRequest.Human.Profile - message.required: true
email SetUpOrgRequest.Human.Email - message.required: true
phone SetUpOrgRequest.Human.Phone -
password string -

SetUpOrgRequest.Human.Email

Field Type Description Validation
email string TODO: check if no value is allowed string.email: true
is_email_verified bool -

SetUpOrgRequest.Human.Phone

Field Type Description Validation
phone string has to be a global number string.min_len: 1
string.max_len: 50
string.prefix: +
is_phone_verified bool -

SetUpOrgRequest.Human.Profile

Field Type Description Validation
first_name string - string.min_len: 1
string.max_len: 200
last_name string - string.min_len: 1
string.max_len: 200
nick_name string - string.max_len: 200
display_name string - string.max_len: 200
preferred_language string - string.max_len: 10
gender zitadel.user.v1.Gender -

SetUpOrgRequest.Org

Field Type Description Validation
name string - string.min_len: 1
string.max_len: 200
domain string - string.max_len: 200

SetUpOrgResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -
org_id string -
user_id string -

UpdateCustomOrgIAMPolicyRequest

Field Type Description Validation
org_id string - string.min_len: 1
string.max_len: 200
user_login_must_be_domain bool -

UpdateCustomOrgIAMPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateIAMMemberRequest

Field Type Description Validation
user_id string - string.min_len: 1
string.max_len: 200
roles repeated string if no roles provided the user won't have any rights

UpdateIAMMemberResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateIDPOIDCConfigRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200
issuer string Fill the issuer if the identity provider is oidc discovery compliant If the identity provider is only oauth2 compliant or does not serve a openid configuration, fill the authorization and token endpoint instead string.min_len: 1
string.max_len: 200
client_id string - string.min_len: 1
string.max_len: 200
client_secret string - string.max_len: 200
scopes repeated string -
display_name_mapping zitadel.idp.v1.OIDCMappingField - enum.defined_only: true
username_mapping zitadel.idp.v1.OIDCMappingField - enum.defined_only: true
authorization_endpoint string If the identity provider does not serve an openid configuration, fill the authorization and token endpoint instead of the issuer string.max_len: 500
token_endpoint string If the identity provider does not serve an openid configuration, fill the authorization and token endpoint instead of the issuer string.max_len: 500

UpdateIDPOIDCConfigResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateIDPRequest

Field Type Description Validation
idp_id string - string.min_len: 1
string.max_len: 200
name string - string.min_len: 1
string.max_len: 200
styling_type zitadel.idp.v1.IDPStylingType - enum.defined_only: true

UpdateIDPResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateLabelPolicyRequest

Field Type Description Validation
primary_color string - string.max_len: 50
hide_login_name_suffix bool -
warn_color string - string.max_len: 50
background_color string - string.max_len: 50
font_color string - string.max_len: 50
primary_color_dark string - string.max_len: 50
background_color_dark string - string.max_len: 50
warn_color_dark string - string.max_len: 50
font_color_dark string - string.max_len: 50
disable_watermark bool -

UpdateLabelPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateLoginPolicyRequest

Field Type Description Validation
allow_username_password bool -
allow_register bool -
allow_external_idp bool -
force_mfa bool -
passwordless_type zitadel.policy.v1.PasswordlessType - enum.defined_only: true
hide_password_reset bool -

UpdateLoginPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdateOrgIAMPolicyRequest

Field Type Description Validation
user_login_must_be_domain bool -

UpdateOrgIAMPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdatePasswordAgePolicyRequest

Field Type Description Validation
max_age_days uint32 -
expire_warn_days uint32 -

UpdatePasswordAgePolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdatePasswordComplexityPolicyRequest

Field Type Description Validation
min_length uint32 -
has_uppercase bool -
has_lowercase bool -
has_number bool -
has_symbol bool -

UpdatePasswordComplexityPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdatePasswordLockoutPolicyRequest

Field Type Description Validation
max_attempts uint32 failed attempts until a user gets locked
show_lockout_failure bool If an error should be displayed during a lockout or not

UpdatePasswordLockoutPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

UpdatePrivacyPolicyRequest

Field Type Description Validation
tos_link string -
privacy_link string -

UpdatePrivacyPolicyResponse

Field Type Description Validation
details zitadel.v1.ObjectDetails -

View

Field Type Description Validation
database string -
view_name string -
processed_sequence uint64 -
event_timestamp google.protobuf.Timestamp The timestamp the event occured
last_successful_spooler_run google.protobuf.Timestamp -