stop tracking events

docs/docs/apis/proto/action.md

@@ -0,0 +1,154 @@
+---
+title: zitadel/action.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Action
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  ActionState | - |  |
+| name |  string | - |  |
+| script |  string | - |  |
+| timeout |  google.protobuf.Duration | - |  |
+| allowed_to_fail |  bool | - |  |
+
+
+
+
+### ActionIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### ActionNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### ActionStateQuery
+ActionStateQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| state |  ActionState | - | enum.defined_only: true<br />  |
+
+
+
+
+### Flow
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  FlowType | id of the flow type |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  FlowState | - |  |
+| trigger_actions | repeated TriggerAction | - |  |
+
+
+
+
+### FlowType
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | identifier of the type |  |
+| name |  zitadel.v1.LocalizedMessage | key and name of the type |  |
+
+
+
+
+### TriggerAction
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| trigger_type |  TriggerType | id of the trigger type |  |
+| actions | repeated Action | - |  |
+
+
+
+
+### TriggerType
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | identifier of the type |  |
+| name |  zitadel.v1.LocalizedMessage | key and name of the type |  |
+
+
+
+
+
+
+## Enums
+
+
+### ActionFieldName {#actionfieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ACTION_FIELD_NAME_UNSPECIFIED | 0 | - |
+| ACTION_FIELD_NAME_NAME | 1 | - |
+| ACTION_FIELD_NAME_ID | 2 | - |
+| ACTION_FIELD_NAME_STATE | 3 | - |
+
+
+
+
+### ActionState {#actionstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ACTION_STATE_UNSPECIFIED | 0 | - |
+| ACTION_STATE_INACTIVE | 1 | - |
+| ACTION_STATE_ACTIVE | 2 | - |
+
+
+
+
+### FlowState {#flowstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| FLOW_STATE_UNSPECIFIED | 0 | - |
+| FLOW_STATE_INACTIVE | 1 | - |
+| FLOW_STATE_ACTIVE | 2 | - |
+
+
+
+

docs/docs/apis/proto/app.md

@@ -0,0 +1,201 @@
+---
+title: zitadel/app.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### APIConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| client_id |  string | - |  |
+| auth_method_type |  APIAuthMethodType | - |  |
+
+
+
+
+### App
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  AppState | - |  |
+| name |  string | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.oidc_config |  OIDCConfig | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.api_config |  APIConfig | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.saml_config |  SAMLConfig | - |  |
+
+
+
+
+### AppNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### AppQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query |  AppNameQuery | - |  |
+
+
+
+
+### OIDCConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| redirect_uris | repeated string | - |  |
+| response_types | repeated OIDCResponseType | - |  |
+| grant_types | repeated OIDCGrantType | - |  |
+| app_type |  OIDCAppType | - |  |
+| client_id |  string | - |  |
+| auth_method_type |  OIDCAuthMethodType | - |  |
+| post_logout_redirect_uris | repeated string | - |  |
+| version |  OIDCVersion | - |  |
+| none_compliant |  bool | - |  |
+| compliance_problems | repeated zitadel.v1.LocalizedMessage | - |  |
+| dev_mode |  bool | - |  |
+| access_token_type |  OIDCTokenType | - |  |
+| access_token_role_assertion |  bool | - |  |
+| id_token_role_assertion |  bool | - |  |
+| id_token_userinfo_assertion |  bool | - |  |
+| clock_skew |  google.protobuf.Duration | - |  |
+| additional_origins | repeated string | - |  |
+| allowed_origins | repeated string | - |  |
+
+
+
+
+### SAMLConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_xml |  bytes | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) metadata.metadata_url |  string | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### APIAuthMethodType {#apiauthmethodtype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| API_AUTH_METHOD_TYPE_BASIC | 0 | - |
+| API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT | 1 | - |
+
+
+
+
+### AppState {#appstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| APP_STATE_UNSPECIFIED | 0 | - |
+| APP_STATE_ACTIVE | 1 | - |
+| APP_STATE_INACTIVE | 2 | - |
+
+
+
+
+### OIDCAppType {#oidcapptype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_APP_TYPE_WEB | 0 | - |
+| OIDC_APP_TYPE_USER_AGENT | 1 | - |
+| OIDC_APP_TYPE_NATIVE | 2 | - |
+
+
+
+
+### OIDCAuthMethodType {#oidcauthmethodtype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_AUTH_METHOD_TYPE_BASIC | 0 | - |
+| OIDC_AUTH_METHOD_TYPE_POST | 1 | - |
+| OIDC_AUTH_METHOD_TYPE_NONE | 2 | - |
+| OIDC_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT | 3 | - |
+
+
+
+
+### OIDCGrantType {#oidcgranttype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_GRANT_TYPE_AUTHORIZATION_CODE | 0 | - |
+| OIDC_GRANT_TYPE_IMPLICIT | 1 | - |
+| OIDC_GRANT_TYPE_REFRESH_TOKEN | 2 | - |
+
+
+
+
+### OIDCResponseType {#oidcresponsetype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_RESPONSE_TYPE_CODE | 0 | - |
+| OIDC_RESPONSE_TYPE_ID_TOKEN | 1 | - |
+| OIDC_RESPONSE_TYPE_ID_TOKEN_TOKEN | 2 | - |
+
+
+
+
+### OIDCTokenType {#oidctokentype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_TOKEN_TYPE_BEARER | 0 | - |
+| OIDC_TOKEN_TYPE_JWT | 1 | - |
+
+
+
+
+### OIDCVersion {#oidcversion}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_VERSION_1_0 | 0 | - |
+
+
+
+

docs/docs/apis/proto/auth_n_key.md

@@ -0,0 +1,41 @@
+---
+title: zitadel/auth_n_key.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Key
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| type |  KeyType | - |  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### KeyType {#keytype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| KEY_TYPE_UNSPECIFIED | 0 | - |
+| KEY_TYPE_JSON | 1 | - |
+
+
+
+

docs/docs/apis/proto/change.md

@@ -0,0 +1,44 @@
+---
+title: zitadel/change.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Change
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| change_date |  google.protobuf.Timestamp | - |  |
+| event_type |  zitadel.v1.LocalizedMessage | - |  |
+| sequence |  uint64 | - |  |
+| editor_id |  string | - |  |
+| editor_display_name |  string | - |  |
+| resource_owner_id |  string | - |  |
+| editor_preferred_login_name |  string | - |  |
+| editor_avatar_url |  string | - |  |
+
+
+
+
+### ChangeQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| sequence |  uint64 | sequence represents the order of events. It's always upcounting |  |
+| limit |  uint32 | - |  |
+| asc |  bool | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/event.md

@@ -0,0 +1,79 @@
+---
+title: zitadel/event.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Aggregate
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| type |  AggregateType | - |  |
+| resource_owner |  string | - |  |
+
+
+
+
+### AggregateType
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  string | - |  |
+| localized |  zitadel.v1.LocalizedMessage | - |  |
+
+
+
+
+### Editor
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| display_name |  string | - |  |
+| service |  string | - |  |
+
+
+
+
+### Event
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| editor |  Editor | - |  |
+| aggregate |  Aggregate | - |  |
+| sequence |  uint64 | - |  |
+| creation_date |  google.protobuf.Timestamp | The timestamp the event occurred |  |
+| payload |  google.protobuf.Struct | - |  |
+| type |  EventType | - |  |
+
+
+
+
+### EventType
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  string | - |  |
+| localized |  zitadel.v1.LocalizedMessage | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/idp.md

@@ -0,0 +1,197 @@
+---
+title: zitadel/idp.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### IDP
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  IDPState | - |  |
+| name |  string | - |  |
+| styling_type |  IDPStylingType | - |  |
+| owner |  IDPOwnerType | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.oidc_config |  OIDCConfig | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.jwt_config |  JWTConfig | - |  |
+| auto_register |  bool | - |  |
+
+
+
+
+### IDPIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### IDPLoginPolicyLink
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| idp_id |  string | - |  |
+| idp_name |  string | - |  |
+| idp_type |  IDPType | - |  |
+
+
+
+
+### IDPNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### IDPOwnerTypeQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| owner_type |  IDPOwnerType | - | enum.defined_only: true<br />  |
+
+
+
+
+### IDPUserLink
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| idp_id |  string | - |  |
+| idp_name |  string | - |  |
+| provided_user_id |  string | - |  |
+| provided_user_name |  string | - |  |
+| idp_type |  IDPType | - |  |
+
+
+
+
+### JWTConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| jwt_endpoint |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| issuer |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| keys_endpoint |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| header_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### OIDCConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| client_id |  string | - |  |
+| issuer |  string | - |  |
+| scopes | repeated string | - |  |
+| display_name_mapping |  OIDCMappingField | - |  |
+| username_mapping |  OIDCMappingField | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### IDPFieldName {#idpfieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDP_FIELD_NAME_UNSPECIFIED | 0 | - |
+| IDP_FIELD_NAME_NAME | 1 | - |
+
+
+
+
+### IDPOwnerType {#idpownertype}
+the owner of the identity provider.
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDP_OWNER_TYPE_UNSPECIFIED | 0 | - |
+| IDP_OWNER_TYPE_SYSTEM | 1 | system is managed by the ZITADEL administrators |
+| IDP_OWNER_TYPE_ORG | 2 | org is managed by de organisation administrators |
+
+
+
+
+### IDPState {#idpstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDP_STATE_UNSPECIFIED | 0 | - |
+| IDP_STATE_ACTIVE | 1 | - |
+| IDP_STATE_INACTIVE | 2 | - |
+
+
+
+
+### IDPStylingType {#idpstylingtype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STYLING_TYPE_UNSPECIFIED | 0 | - |
+| STYLING_TYPE_GOOGLE | 1 | - |
+
+
+
+
+### IDPType {#idptype}
+authorization framework of the identity provider
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDP_TYPE_UNSPECIFIED | 0 | - |
+| IDP_TYPE_OIDC | 1 | - |
+| IDP_TYPE_JWT | 3 | PLANNED: IDP_TYPE_SAML |
+
+
+
+
+### OIDCMappingField {#oidcmappingfield}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OIDC_MAPPING_FIELD_UNSPECIFIED | 0 | - |
+| OIDC_MAPPING_FIELD_PREFERRED_USERNAME | 1 | - |
+| OIDC_MAPPING_FIELD_EMAIL | 2 | - |
+
+
+
+

docs/docs/apis/proto/instance.md

@@ -0,0 +1,172 @@
+---
+title: zitadel/instance.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Domain
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| domain |  string | - |  |
+| primary |  bool | - |  |
+| generated |  bool | - |  |
+
+
+
+
+### DomainGeneratedQuery
+DomainGeneratedQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| generated |  bool | - |  |
+
+
+
+
+### DomainPrimaryQuery
+DomainPrimaryQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| primary |  bool | - |  |
+
+
+
+
+### DomainQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| domain |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### DomainSearchQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_query |  DomainQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.generated_query |  DomainGeneratedQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.primary_query |  DomainPrimaryQuery | - |  |
+
+
+
+
+### IdsQuery
+IdQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| ids | repeated string | - |  |
+
+
+
+
+### Instance
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  State | - |  |
+| name |  string | - |  |
+| version |  string | - |  |
+| domains | repeated Domain | - |  |
+
+
+
+
+### InstanceDetail
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  State | - |  |
+| name |  string | - |  |
+| version |  string | - |  |
+| domains | repeated Domain | - |  |
+
+
+
+
+### Query
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.id_query |  IdsQuery | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### DomainFieldName {#domainfieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DOMAIN_FIELD_NAME_UNSPECIFIED | 0 | - |
+| DOMAIN_FIELD_NAME_DOMAIN | 1 | - |
+| DOMAIN_FIELD_NAME_PRIMARY | 2 | - |
+| DOMAIN_FIELD_NAME_GENERATED | 3 | - |
+| DOMAIN_FIELD_NAME_CREATION_DATE | 4 | - |
+
+
+
+
+### FieldName {#fieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| FIELD_NAME_UNSPECIFIED | 0 | - |
+| FIELD_NAME_ID | 1 | - |
+| FIELD_NAME_NAME | 2 | - |
+| FIELD_NAME_CREATION_DATE | 3 | - |
+
+
+
+
+### State {#state}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATE_UNSPECIFIED | 0 | - |
+| STATE_CREATING | 1 | - |
+| STATE_RUNNING | 2 | - |
+| STATE_STOPPING | 3 | - |
+| STATE_STOPPED | 4 | - |
+
+
+
+

docs/docs/apis/proto/member.md

@@ -0,0 +1,93 @@
+---
+title: zitadel/member.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### EmailQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### FirstNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### LastNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| last_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### Member
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| roles | repeated string | - |  |
+| preferred_login_name |  string | - |  |
+| email |  string | - |  |
+| first_name |  string | - |  |
+| last_name |  string | - |  |
+| display_name |  string | - |  |
+| avatar_url |  string | - |  |
+
+
+
+
+### SearchQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query |  FirstNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query |  LastNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query |  EmailQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_id_query |  UserIDQuery | - |  |
+
+
+
+
+### UserIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+
+

docs/docs/apis/proto/message.md

@@ -0,0 +1,37 @@
+---
+title: zitadel/message.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### ErrorDetail
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| message |  string | - |  |
+
+
+
+
+### LocalizedMessage
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - |  |
+| localized_message |  string | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/metadata.md

@@ -0,0 +1,49 @@
+---
+title: zitadel/metadata.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Metadata
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| key |  string | - |  |
+| value |  bytes | - |  |
+
+
+
+
+### MetadataKeyQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### MetadataQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.key_query |  MetadataKeyQuery | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/object.md

@@ -0,0 +1,95 @@
+---
+title: zitadel/object.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### ListDetails
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| total_result |  uint64 | - |  |
+| processed_sequence |  uint64 | - |  |
+| view_timestamp |  google.protobuf.Timestamp | - |  |
+
+
+
+
+### ListQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| offset |  uint64 | - |  |
+| limit |  uint32 | - |  |
+| asc |  bool | - |  |
+
+
+
+
+### ObjectDetails
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| sequence |  uint64 | sequence represents the order of events. It's always upcounting
+
+on read: the sequence of the last event reduced by the projection
+
+on manipulation: the timestamp of the event(s) added by the manipulation |  |
+| creation_date |  google.protobuf.Timestamp | creation_date is the timestamp where the first operation on the object was made
+
+on read: the timestamp of the first event of the object
+
+on create: the timestamp of the event(s) added by the manipulation |  |
+| change_date |  google.protobuf.Timestamp | change_date is the timestamp when the object was changed
+
+on read: the timestamp of the last event reduced by the projection
+
+on manipulation: the |  |
+| resource_owner |  string | resource_owner is the organisation an object belongs to |  |
+
+
+
+
+
+
+## Enums
+
+
+### ListQueryMethod {#listquerymethod}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| LIST_QUERY_METHOD_IN | 0 | - |
+
+
+
+
+### TextQueryMethod {#textquerymethod}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TEXT_QUERY_METHOD_EQUALS | 0 | - |
+| TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE | 1 | - |
+| TEXT_QUERY_METHOD_STARTS_WITH | 2 | - |
+| TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE | 3 | - |
+| TEXT_QUERY_METHOD_CONTAINS | 4 | - |
+| TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE | 5 | - |
+| TEXT_QUERY_METHOD_ENDS_WITH | 6 | - |
+| TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE | 7 | - |
+
+
+
+

docs/docs/apis/proto/options.md

@@ -0,0 +1,25 @@
+---
+title: zitadel/options.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### AuthOption
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| permission |  string | - |  |
+| check_field_name |  string | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/org.md

@@ -0,0 +1,154 @@
+---
+title: zitadel/org.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### Domain
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| domain_name |  string | - |  |
+| is_verified |  bool | - |  |
+| is_primary |  bool | - |  |
+| validation_type |  DomainValidationType | - |  |
+
+
+
+
+### DomainNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### DomainSearchQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_name_query |  DomainNameQuery | - |  |
+
+
+
+
+### Org
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  OrgState | - |  |
+| name |  string | - |  |
+| primary_domain |  string | - |  |
+
+
+
+
+### OrgDomainQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| domain |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### OrgNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### OrgQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query |  OrgNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.domain_query |  OrgDomainQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query |  OrgStateQuery | - |  |
+
+
+
+
+### OrgStateQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| state |  OrgState | - | enum.defined_only: true<br />  |
+
+
+
+
+
+
+## Enums
+
+
+### DomainValidationType {#domainvalidationtype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DOMAIN_VALIDATION_TYPE_UNSPECIFIED | 0 | - |
+| DOMAIN_VALIDATION_TYPE_HTTP | 1 | - |
+| DOMAIN_VALIDATION_TYPE_DNS | 2 | - |
+
+
+
+
+### OrgFieldName {#orgfieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ORG_FIELD_NAME_UNSPECIFIED | 0 | - |
+| ORG_FIELD_NAME_NAME | 1 | - |
+
+
+
+
+### OrgState {#orgstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ORG_STATE_UNSPECIFIED | 0 | - |
+| ORG_STATE_ACTIVE | 1 | - |
+| ORG_STATE_INACTIVE | 2 | - |
+| ORG_STATE_REMOVED | 3 | - |
+
+
+
+

docs/docs/apis/proto/policy.md

@@ -0,0 +1,208 @@
+---
+title: zitadel/policy.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### DomainPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| user_login_must_be_domain |  bool | - |  |
+| is_default |  bool | - |  |
+| validate_org_domains |  bool | - |  |
+| smtp_sender_address_matches_instance_domain |  bool | - |  |
+
+
+
+
+### LabelPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| primary_color |  string | hex value for primary color |  |
+| is_default |  bool | defines if the organisation's admin changed the policy |  |
+| hide_login_name_suffix |  bool | hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set |  |
+| warn_color |  string | hex value for secondary color |  |
+| background_color |  string | hex value for background color |  |
+| font_color |  string | hex value for font color |  |
+| primary_color_dark |  string | hex value for primary color dark theme |  |
+| background_color_dark |  string | hex value for background color dark theme |  |
+| warn_color_dark |  string | hex value for warn color dark theme |  |
+| font_color_dark |  string | hex value for font color dark theme |  |
+| disable_watermark |  bool | - |  |
+| logo_url |  string | - |  |
+| icon_url |  string | - |  |
+| logo_url_dark |  string | - |  |
+| icon_url_dark |  string | - |  |
+| font_url |  string | - |  |
+
+
+
+
+### LockoutPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| max_password_attempts |  uint64 | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### LoginPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| allow_username_password |  bool | - |  |
+| allow_register |  bool | - |  |
+| allow_external_idp |  bool | - |  |
+| force_mfa |  bool | - |  |
+| passwordless_type |  PasswordlessType | - |  |
+| is_default |  bool | - |  |
+| hide_password_reset |  bool | - |  |
+| ignore_unknown_usernames |  bool | - |  |
+| default_redirect_uri |  string | - |  |
+| password_check_lifetime |  google.protobuf.Duration | - |  |
+| external_login_check_lifetime |  google.protobuf.Duration | - |  |
+| mfa_init_skip_lifetime |  google.protobuf.Duration | - |  |
+| second_factor_check_lifetime |  google.protobuf.Duration | - |  |
+| multi_factor_check_lifetime |  google.protobuf.Duration | - |  |
+| second_factors | repeated SecondFactorType | - |  |
+| multi_factors | repeated MultiFactorType | - |  |
+| idps | repeated zitadel.idp.v1.IDPLoginPolicyLink | - |  |
+| allow_domain_discovery |  bool | If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organisation on success. |  |
+| disable_login_with_email |  bool | - |  |
+| disable_login_with_phone |  bool | - |  |
+
+
+
+
+### NotificationPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| is_default |  bool | - |  |
+| password_change |  bool | - |  |
+
+
+
+
+### OrgIAMPolicy
+deprecated: please use DomainPolicy instead
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| user_login_must_be_domain |  bool | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### PasswordAgePolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| max_age_days |  uint64 | - |  |
+| expire_warn_days |  uint64 | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### PasswordComplexityPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| min_length |  uint64 | - |  |
+| has_uppercase |  bool | - |  |
+| has_lowercase |  bool | - |  |
+| has_number |  bool | - |  |
+| has_symbol |  bool | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### PrivacyPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| tos_link |  string | - |  |
+| privacy_link |  string | - |  |
+| is_default |  bool | - |  |
+| help_link |  string | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### MultiFactorType {#multifactortype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| MULTI_FACTOR_TYPE_UNSPECIFIED | 0 | - |
+| MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION | 1 | - |
+
+
+
+
+### PasswordlessType {#passwordlesstype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PASSWORDLESS_TYPE_NOT_ALLOWED | 0 | - |
+| PASSWORDLESS_TYPE_ALLOWED | 1 | PLANNED: PASSWORDLESS_TYPE_WITH_CERT |
+
+
+
+
+### SecondFactorType {#secondfactortype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECOND_FACTOR_TYPE_UNSPECIFIED | 0 | - |
+| SECOND_FACTOR_TYPE_OTP | 1 | - |
+| SECOND_FACTOR_TYPE_U2F | 2 | - |
+
+
+
+

docs/docs/apis/proto/project.md

@@ -0,0 +1,247 @@
+---
+title: zitadel/project.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### AllProjectGrantQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query |  GrantProjectNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query |  GrantRoleKeyQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_id_query |  ProjectIDQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.granted_org_id_query |  GrantedOrgIDQuery | - |  |
+
+
+
+
+### GrantProjectNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### GrantRoleKeyQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| role_key |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### GrantedOrgIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| granted_org_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### GrantedProject
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| grant_id |  string | - |  |
+| granted_org_id |  string | - |  |
+| granted_org_name |  string | - |  |
+| granted_role_keys | repeated string | - |  |
+| state |  ProjectGrantState | - |  |
+| project_id |  string | - |  |
+| project_name |  string | - |  |
+| project_owner_id |  string | - |  |
+| project_owner_name |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### Project
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| name |  string | - |  |
+| state |  ProjectState | - |  |
+| project_role_assertion |  bool | describes if roles of user should be added in token |  |
+| project_role_check |  bool | ZITADEL checks if the user has at least one on this project |  |
+| has_project_check |  bool | ZITADEL checks if the org of the user has permission to this project |  |
+| private_labeling_setting |  PrivateLabelingSetting | Defines from where the private labeling should be triggered |  |
+
+
+
+
+### ProjectGrantQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query |  GrantProjectNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query |  GrantRoleKeyQuery | - |  |
+
+
+
+
+### ProjectIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### ProjectNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### ProjectQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.name_query |  ProjectNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_resource_owner_query |  ProjectResourceOwnerQuery | - |  |
+
+
+
+
+### ProjectResourceOwnerQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| resource_owner |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### Role
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| display_name |  string | - |  |
+| group |  string | - |  |
+
+
+
+
+### RoleDisplayNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| display_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### RoleKeyQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### RoleQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.key_query |  RoleKeyQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query |  RoleDisplayNameQuery | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### PrivateLabelingSetting {#privatelabelingsetting}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PRIVATE_LABELING_SETTING_UNSPECIFIED | 0 | - |
+| PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY | 1 | - |
+| PRIVATE_LABELING_SETTING_ALLOW_LOGIN_USER_RESOURCE_OWNER_POLICY | 2 | - |
+
+
+
+
+### ProjectGrantState {#projectgrantstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROJECT_GRANT_STATE_UNSPECIFIED | 0 | - |
+| PROJECT_GRANT_STATE_ACTIVE | 1 | - |
+| PROJECT_GRANT_STATE_INACTIVE | 2 | - |
+
+
+
+
+### ProjectState {#projectstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROJECT_STATE_UNSPECIFIED | 0 | - |
+| PROJECT_STATE_ACTIVE | 1 | - |
+| PROJECT_STATE_INACTIVE | 2 | - |
+
+
+
+

docs/docs/apis/proto/settings.md

@@ -0,0 +1,166 @@
+---
+title: zitadel/settings.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### DebugNotificationProvider
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| compact |  bool | - |  |
+
+
+
+
+### OIDCSettings
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| access_token_lifetime |  google.protobuf.Duration | - |  |
+| id_token_lifetime |  google.protobuf.Duration | - |  |
+| refresh_token_idle_expiration |  google.protobuf.Duration | - |  |
+| refresh_token_expiration |  google.protobuf.Duration | - |  |
+
+
+
+
+### SMSProvider
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| id |  string | - |  |
+| state |  SMSProviderConfigState | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) config.twilio |  TwilioConfig | - |  |
+
+
+
+
+### SMTPConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| sender_address |  string | - |  |
+| sender_name |  string | - |  |
+| tls |  bool | - |  |
+| host |  string | - |  |
+| user |  string | - |  |
+
+
+
+
+### SecretGenerator
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| generator_type |  SecretGeneratorType | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| length |  uint32 | - |  |
+| expiry |  google.protobuf.Duration | - |  |
+| include_lower_letters |  bool | - |  |
+| include_upper_letters |  bool | - |  |
+| include_digits |  bool | - |  |
+| include_symbols |  bool | - |  |
+
+
+
+
+### SecretGeneratorQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.type_query |  SecretGeneratorTypeQuery | - |  |
+
+
+
+
+### SecretGeneratorTypeQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| generator_type |  SecretGeneratorType | - |  |
+
+
+
+
+### SecurityPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| enable_iframe_embedding |  bool | states if iframe embedding is enabled or disabled |  |
+| allowed_origins | repeated string | origins allowed to load ZITADEL in an iframe if enable_iframe_embedding is true |  |
+
+
+
+
+### TwilioConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| sid |  string | - |  |
+| sender_number |  string | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### SMSProviderConfigState {#smsproviderconfigstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED | 0 | - |
+| SMS_PROVIDER_CONFIG_ACTIVE | 1 | - |
+| SMS_PROVIDER_CONFIG_INACTIVE | 2 | - |
+
+
+
+
+### SecretGeneratorType {#secretgeneratortype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_GENERATOR_TYPE_UNSPECIFIED | 0 | - |
+| SECRET_GENERATOR_TYPE_INIT_CODE | 1 | - |
+| SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE | 2 | - |
+| SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE | 3 | - |
+| SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE | 4 | - |
+| SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE | 5 | - |
+| SECRET_GENERATOR_TYPE_APP_SECRET | 6 | - |
+
+
+
+

docs/docs/apis/proto/system.md

@@ -0,0 +1,826 @@
+---
+title: zitadel/system.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+## SystemService {#zitadelsystemv1systemservice}
+
+
+### Healthz
+
+> **rpc** Healthz([HealthzRequest](#healthzrequest))
+[HealthzResponse](#healthzresponse)
+
+Indicates if ZITADEL is running.
+It respondes as soon as ZITADEL started
+
+
+
+    GET: /healthz
+
+
+### ListInstances
+
+> **rpc** ListInstances([ListInstancesRequest](#listinstancesrequest))
+[ListInstancesResponse](#listinstancesresponse)
+
+Returns a list of ZITADEL instances
+
+
+
+    POST: /instances/_search
+
+
+### GetInstance
+
+> **rpc** GetInstance([GetInstanceRequest](#getinstancerequest))
+[GetInstanceResponse](#getinstanceresponse)
+
+Returns the detail of an instance
+
+
+
+    GET: /instances/{instance_id}
+
+
+### AddInstance
+
+> **rpc** AddInstance([AddInstanceRequest](#addinstancerequest))
+[AddInstanceResponse](#addinstanceresponse)
+
+Deprecated: Use CreateInstance instead
+Creates a new instance with all needed setup data
+This might take some time
+
+
+
+    POST: /instances
+
+
+### UpdateInstance
+
+> **rpc** UpdateInstance([UpdateInstanceRequest](#updateinstancerequest))
+[UpdateInstanceResponse](#updateinstanceresponse)
+
+Updates name of an existing instance
+
+
+
+    PUT: /instances/{instance_id}
+
+
+### CreateInstance
+
+> **rpc** CreateInstance([CreateInstanceRequest](#createinstancerequest))
+[CreateInstanceResponse](#createinstanceresponse)
+
+Creates a new instance with all needed setup data
+This might take some time
+
+
+
+    POST: /instances/_create
+
+
+### RemoveInstance
+
+> **rpc** RemoveInstance([RemoveInstanceRequest](#removeinstancerequest))
+[RemoveInstanceResponse](#removeinstanceresponse)
+
+Removes a instances
+This might take some time
+
+
+
+    DELETE: /instances/{instance_id}
+
+
+### ListIAMMembers
+
+> **rpc** ListIAMMembers([ListIAMMembersRequest](#listiammembersrequest))
+[ListIAMMembersResponse](#listiammembersresponse)
+
+Returns all instance members matching the request
+all queries need to match (ANDed)
+
+
+
+    POST: /instances/{instance_id}/members/_search
+
+
+### ExistsDomain
+
+> **rpc** ExistsDomain([ExistsDomainRequest](#existsdomainrequest))
+[ExistsDomainResponse](#existsdomainresponse)
+
+Checks if a domain exists
+
+
+
+    POST: /domains/{domain}/_exists
+
+
+### ListDomains
+
+> **rpc** ListDomains([ListDomainsRequest](#listdomainsrequest))
+[ListDomainsResponse](#listdomainsresponse)
+
+Returns the custom domains of an instance
+
+
+
+    POST: /instances/{instance_id}/domains/_search
+
+
+### AddDomain
+
+> **rpc** AddDomain([AddDomainRequest](#adddomainrequest))
+[AddDomainResponse](#adddomainresponse)
+
+Returns the domain of an instance
+
+
+
+    POST: /instances/{instance_id}/domains
+
+
+### RemoveDomain
+
+> **rpc** RemoveDomain([RemoveDomainRequest](#removedomainrequest))
+[RemoveDomainResponse](#removedomainresponse)
+
+Returns the domain of an instance
+
+
+
+    DELETE: /instances/{instance_id}/domains/{domain}
+
+
+### SetPrimaryDomain
+
+> **rpc** SetPrimaryDomain([SetPrimaryDomainRequest](#setprimarydomainrequest))
+[SetPrimaryDomainResponse](#setprimarydomainresponse)
+
+Returns the domain of an instance
+
+
+
+    POST: /instances/{instance_id}/domains/_set_primary
+
+
+### ListViews
+
+> **rpc** ListViews([ListViewsRequest](#listviewsrequest))
+[ListViewsResponse](#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](#clearviewrequest))
+[ClearViewResponse](#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](#listfailedeventsrequest))
+[ListFailedEventsResponse](#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](#removefailedeventrequest))
+[RemoveFailedEventResponse](#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
+
+
+### AddDomainRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| domain |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### AddDomainResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### AddInstanceRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| first_org_name |  string | - | string.max_len: 200<br />  |
+| custom_domain |  string | - | string.max_len: 200<br />  |
+| owner_user_name |  string | - | string.max_len: 200<br />  |
+| owner_email |  AddInstanceRequest.Email | - | message.required: true<br />  |
+| owner_profile |  AddInstanceRequest.Profile | - | message.required: false<br />  |
+| owner_password |  AddInstanceRequest.Password | - | message.required: false<br />  |
+| default_language |  string | - | string.max_len: 10<br />  |
+
+
+
+
+### AddInstanceRequest.Email
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| is_email_verified |  bool | - |  |
+
+
+
+
+### AddInstanceRequest.Password
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| password |  string | - | string.max_len: 200<br />  |
+| password_change_required |  bool | - |  |
+
+
+
+
+### AddInstanceRequest.Profile
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.max_len: 200<br />  |
+| last_name |  string | - | string.max_len: 200<br />  |
+| preferred_language |  string | - | string.max_len: 10<br />  |
+
+
+
+
+### AddInstanceResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### ChangeSubscriptionRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| domain |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| subscription_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| request_limit |  uint64 | - |  |
+| action_mins_limit |  uint64 | - |  |
+
+
+
+
+### ChangeSubscriptionResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### ClearViewRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| database |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| view_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### ClearViewResponse
+This is an empty response
+
+
+
+
+### CreateInstanceRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| first_org_name |  string | - | string.max_len: 200<br />  |
+| custom_domain |  string | - | string.max_len: 200<br />  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) owner.human |  CreateInstanceRequest.Human | oneof field for the user managing the instance |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) owner.machine |  CreateInstanceRequest.Machine | - |  |
+| default_language |  string | - | string.max_len: 10<br />  |
+
+
+
+
+### CreateInstanceRequest.Email
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | - | string.min_len: 1<br /> string.max_len: 200<br /> string.email: true<br />  |
+| is_email_verified |  bool | - |  |
+
+
+
+
+### CreateInstanceRequest.Human
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_name |  string | - | string.max_len: 200<br />  |
+| email |  CreateInstanceRequest.Email | - | message.required: true<br />  |
+| profile |  CreateInstanceRequest.Profile | - | message.required: false<br />  |
+| password |  CreateInstanceRequest.Password | - | message.required: false<br />  |
+
+
+
+
+### CreateInstanceRequest.Machine
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_name |  string | - | string.max_len: 200<br />  |
+| name |  string | - | string.max_len: 200<br />  |
+| personal_access_token |  CreateInstanceRequest.PersonalAccessToken | - |  |
+| machine_key |  CreateInstanceRequest.MachineKey | - |  |
+
+
+
+
+### CreateInstanceRequest.MachineKey
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  zitadel.authn.v1.KeyType | - | enum.defined_only: true<br /> enum.not_in: [0]<br />  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+
+
+
+
+### CreateInstanceRequest.Password
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| password |  string | - | string.max_len: 200<br />  |
+| password_change_required |  bool | - |  |
+
+
+
+
+### CreateInstanceRequest.PersonalAccessToken
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+
+
+
+
+### CreateInstanceRequest.Profile
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.max_len: 200<br />  |
+| last_name |  string | - | string.max_len: 200<br />  |
+| preferred_language |  string | - | string.max_len: 10<br />  |
+
+
+
+
+### CreateInstanceResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| pat |  string | - |  |
+| machine_key |  bytes | - |  |
+
+
+
+
+### ExistsDomainRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| domain |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### ExistsDomainResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| exists |  bool | - |  |
+
+
+
+
+### FailedEvent
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| database |  string | - |  |
+| view_name |  string | - |  |
+| failed_sequence |  uint64 | - |  |
+| failure_count |  uint64 | - |  |
+| error_message |  string | - |  |
+| last_failed |  google.protobuf.Timestamp | - |  |
+
+
+
+
+### GetInstanceRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### GetInstanceResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance |  zitadel.instance.v1.InstanceDetail | - |  |
+
+
+
+
+### GetUsageRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### GetUsageResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| executed_requests |  uint64 | - |  |
+| executed_action_mins |  uint64 | - |  |
+
+
+
+
+### HealthzRequest
+This is an empty request
+
+
+
+
+### HealthzResponse
+This is an empty response
+
+
+
+
+### ListDomainsRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | list limitations and ordering | string.min_len: 1<br /> string.max_len: 200<br />  |
+| query |  zitadel.v1.ListQuery | - |  |
+| sorting_column |  zitadel.instance.v1.DomainFieldName | the field the result is sorted |  |
+| queries | repeated zitadel.instance.v1.DomainSearchQuery | criterias the client is looking for |  |
+
+
+
+
+### ListDomainsResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ListDetails | - |  |
+| sorting_column |  zitadel.instance.v1.DomainFieldName | - |  |
+| result | repeated zitadel.instance.v1.Domain | - |  |
+
+
+
+
+### ListFailedEventsRequest
+This is an empty request
+
+
+
+
+### ListFailedEventsResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| result | repeated FailedEvent | TODO: list details |  |
+
+
+
+
+### ListIAMMembersRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| query |  zitadel.v1.ListQuery | - |  |
+| instance_id |  string | - |  |
+| queries | repeated zitadel.member.v1.SearchQuery | - |  |
+
+
+
+
+### ListIAMMembersResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ListDetails | - |  |
+| result | repeated zitadel.member.v1.Member | - |  |
+
+
+
+
+### ListInstancesRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| query |  zitadel.v1.ListQuery | list limitations and ordering |  |
+| sorting_column |  zitadel.instance.v1.FieldName | the field the result is sorted |  |
+| queries | repeated zitadel.instance.v1.Query | criterias the client is looking for |  |
+
+
+
+
+### ListInstancesResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ListDetails | - |  |
+| sorting_column |  zitadel.instance.v1.FieldName | - |  |
+| result | repeated zitadel.instance.v1.Instance | - |  |
+
+
+
+
+### ListViewsRequest
+This is an empty request
+
+
+
+
+### ListViewsResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| result | repeated View | TODO: list details |  |
+
+
+
+
+### RemoveDomainRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| domain |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### RemoveDomainResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### RemoveFailedEventRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| database |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| view_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| failed_sequence |  uint64 | - |  |
+| instance_id |  string | - |  |
+
+
+
+
+### RemoveFailedEventResponse
+This is an empty response
+
+
+
+
+### RemoveInstanceRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### RemoveInstanceResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### SetPrimaryDomainRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| domain |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### SetPrimaryDomainResponse
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+
+
+
+
+### UpdateInstanceRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| instance_id |  string | - |  |
+| instance_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+### UpdateInstanceResponse
+
+
+
+| 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 | - |  |
+| instance |  string | - |  |
+
+
+
+
+
+

docs/docs/apis/proto/text.md

@@ -0,0 +1,637 @@
+---
+title: zitadel/text.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### EmailVerificationDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| login_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### EmailVerificationScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### ExternalRegistrationUserOverviewScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| email_label |  string | - | string.max_len: 200<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| firstname_label |  string | - | string.max_len: 200<br />  |
+| lastname_label |  string | - | string.max_len: 200<br />  |
+| nickname_label |  string | - | string.max_len: 200<br />  |
+| language_label |  string | - | string.max_len: 200<br />  |
+| phone_label |  string | - | string.max_len: 200<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| back_button_text |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 200<br />  |
+| privacy_confirm |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### ExternalUserNotFoundScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| link_button_text |  string | - | string.max_len: 100<br />  |
+| auto_register_button_text |  string | - | string.max_len: 100<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_confirm |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### FooterText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| tos |  string | - | string.max_len: 200<br />  |
+| privacy_policy |  string | - | string.max_len: 200<br />  |
+| help |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### InitMFADoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAOTPScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_otp |  string | - | string.max_len: 500<br />  |
+| secret_label |  string | - | string.max_len: 200<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAPromptScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| otp_option |  string | - | string.max_len: 200<br />  |
+| u2f_option |  string | - | string.max_len: 200<br />  |
+| skip_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitMFAU2FScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| token_name_label |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| register_token_button_text |  string | - | string.max_len: 100<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### InitPasswordDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitPasswordScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitializeUserDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### InitializeUserScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| resend_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### LinkingUserDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### LoginCustomText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| select_account_text |  SelectAccountScreenText | - |  |
+| login_text |  LoginScreenText | - |  |
+| password_text |  PasswordScreenText | - |  |
+| username_change_text |  UsernameChangeScreenText | - |  |
+| username_change_done_text |  UsernameChangeDoneScreenText | - |  |
+| init_password_text |  InitPasswordScreenText | - |  |
+| init_password_done_text |  InitPasswordDoneScreenText | - |  |
+| email_verification_text |  EmailVerificationScreenText | - |  |
+| email_verification_done_text |  EmailVerificationDoneScreenText | - |  |
+| initialize_user_text |  InitializeUserScreenText | - |  |
+| initialize_done_text |  InitializeUserDoneScreenText | - |  |
+| init_mfa_prompt_text |  InitMFAPromptScreenText | - |  |
+| init_mfa_otp_text |  InitMFAOTPScreenText | - |  |
+| init_mfa_u2f_text |  InitMFAU2FScreenText | - |  |
+| init_mfa_done_text |  InitMFADoneScreenText | - |  |
+| mfa_providers_text |  MFAProvidersText | - |  |
+| verify_mfa_otp_text |  VerifyMFAOTPScreenText | - |  |
+| verify_mfa_u2f_text |  VerifyMFAU2FScreenText | - |  |
+| passwordless_text |  PasswordlessScreenText | - |  |
+| password_change_text |  PasswordChangeScreenText | - |  |
+| password_change_done_text |  PasswordChangeDoneScreenText | - |  |
+| password_reset_done_text |  PasswordResetDoneScreenText | - |  |
+| registration_option_text |  RegistrationOptionScreenText | - |  |
+| registration_user_text |  RegistrationUserScreenText | - |  |
+| registration_org_text |  RegistrationOrgScreenText | - |  |
+| linking_user_done_text |  LinkingUserDoneScreenText | - |  |
+| external_user_not_found_text |  ExternalUserNotFoundScreenText | - |  |
+| success_login_text |  SuccessLoginScreenText | - |  |
+| logout_text |  LogoutDoneScreenText | - |  |
+| footer_text |  FooterText | - |  |
+| passwordless_prompt_text |  PasswordlessPromptScreenText | - |  |
+| passwordless_registration_text |  PasswordlessRegistrationScreenText | - |  |
+| passwordless_registration_done_text |  PasswordlessRegistrationDoneScreenText | - |  |
+| external_registration_user_overview_text |  ExternalRegistrationUserOverviewScreenText | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### LoginScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| title_linking_process |  string | - | string.max_len: 200<br />  |
+| description_linking_process |  string | - | string.max_len: 500<br />  |
+| user_must_be_member_of_org |  string | - | string.max_len: 500<br />  |
+| login_name_label |  string | - | string.max_len: 200<br />  |
+| register_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| external_user_description |  string | - | string.max_len: 500<br />  |
+| user_name_placeholder |  string | - | string.max_len: 200<br />  |
+| login_name_placeholder |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### LogoutDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| login_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MFAProvidersText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| choose_other |  string | - | string.max_len: 500<br />  |
+| otp |  string | - | string.max_len: 200<br />  |
+| u2f |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MessageCustomText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| title |  string | - |  |
+| pre_header |  string | - |  |
+| subject |  string | - |  |
+| greeting |  string | - |  |
+| text |  string | - |  |
+| button_text |  string | - |  |
+| footer_text |  string | - |  |
+| is_default |  bool | - |  |
+
+
+
+
+### PasswordChangeDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordChangeScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| old_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_label |  string | - | string.max_len: 200<br />  |
+| new_password_confirm_label |  string | - | string.max_len: 200<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordResetDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| reset_link_text |  string | - | string.max_len: 100<br />  |
+| back_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| min_length |  string | - | string.max_len: 100<br />  |
+| has_uppercase |  string | - | string.max_len: 100<br />  |
+| has_lowercase |  string | - | string.max_len: 100<br />  |
+| has_number |  string | - | string.max_len: 100<br />  |
+| has_symbol |  string | - | string.max_len: 100<br />  |
+| confirmation |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessPromptScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_init |  string | - | string.max_len: 500<br />  |
+| passwordless_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| skip_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessRegistrationDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| description_close |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### PasswordlessRegistrationScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| token_name_label |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| register_token_button_text |  string | - | string.max_len: 100<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### PasswordlessScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| login_with_pw_button_text |  string | - | string.max_len: 100<br />  |
+| validate_token_button_text |  string | - | string.max_len: 200<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### RegistrationOptionScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| user_name_button_text |  string | - | string.max_len: 200<br />  |
+| external_login_description |  string | - | string.max_len: 500<br />  |
+| login_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### RegistrationOrgScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| orgname_label |  string | - | string.max_len: 200<br />  |
+| firstname_label |  string | - | string.max_len: 200<br />  |
+| lastname_label |  string | - | string.max_len: 200<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| email_label |  string | - | string.max_len: 200<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| password_confirm_label |  string | - | string.max_len: 200<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_confirm |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| save_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### RegistrationUserScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| description_org_register |  string | - | string.max_len: 500<br />  |
+| firstname_label |  string | - | string.max_len: 200<br />  |
+| lastname_label |  string | - | string.max_len: 200<br />  |
+| email_label |  string | - | string.max_len: 200<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| language_label |  string | - | string.max_len: 200<br />  |
+| gender_label |  string | - | string.max_len: 200<br />  |
+| password_label |  string | - | string.max_len: 200<br />  |
+| password_confirm_label |  string | - | string.max_len: 200<br />  |
+| tos_and_privacy_label |  string | - | string.max_len: 200<br />  |
+| tos_confirm |  string | - | string.max_len: 200<br />  |
+| tos_link_text |  string | - | string.max_len: 200<br />  |
+| privacy_confirm |  string | - | string.max_len: 200<br />  |
+| privacy_link_text |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 200<br />  |
+| back_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### SelectAccountScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| title_linking_process |  string | - | string.max_len: 200<br />  |
+| description_linking_process |  string | - | string.max_len: 500<br />  |
+| other_user |  string | - | string.max_len: 500<br />  |
+| session_state_active |  string | - | string.max_len: 100<br />  |
+| session_state_inactive |  string | - | string.max_len: 100<br />  |
+| user_must_be_member_of_org |  string | - | string.max_len: 500<br />  |
+
+
+
+
+### SuccessLoginScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| auto_redirect_description |  string | Text to describe that auto redirect should happen after successful login | string.max_len: 500<br />  |
+| redirected_description |  string | Text to describe that the window can be closed after redirect | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### UsernameChangeDoneScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### UsernameChangeScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| username_label |  string | - | string.max_len: 200<br />  |
+| cancel_button_text |  string | - | string.max_len: 100<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### VerifyMFAOTPScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| code_label |  string | - | string.max_len: 200<br />  |
+| next_button_text |  string | - | string.max_len: 100<br />  |
+
+
+
+
+### VerifyMFAU2FScreenText
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| title |  string | - | string.max_len: 200<br />  |
+| description |  string | - | string.max_len: 500<br />  |
+| validate_token_text |  string | - | string.max_len: 500<br />  |
+| not_supported |  string | - | string.max_len: 500<br />  |
+| error_retry |  string | - | string.max_len: 500<br />  |
+
+
+
+
+
+

docs/docs/apis/proto/user.md

@@ -0,0 +1,743 @@
+---
+title: zitadel/user.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### AuthFactor
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| state |  AuthFactorState | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.otp |  AuthFactorOTP | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.u2f |  AuthFactorU2F | - |  |
+
+
+
+
+### AuthFactorOTP
+
+
+
+
+
+### AuthFactorU2F
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| name |  string | - |  |
+
+
+
+
+### DisplayNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| display_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### Email
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | - |  |
+| is_email_verified |  bool | - |  |
+
+
+
+
+### EmailQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email_address |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### FirstNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### Human
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| profile |  Profile | - |  |
+| email |  Email | - |  |
+| phone |  Phone | - |  |
+
+
+
+
+### LastNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| last_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### LoginNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| login_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### Machine
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - |  |
+| description |  string | - |  |
+| has_secret |  bool | - |  |
+| access_token_typ |  AccessTokenType | - |  |
+
+
+
+
+### Membership
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| roles | repeated string | - |  |
+| display_name |  string | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.iam |  bool | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.org_id |  string | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.project_id |  string | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.project_grant_id |  string | - |  |
+
+
+
+
+### MembershipIAMQuery
+this query is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| iam |  bool | - |  |
+
+
+
+
+### MembershipOrgQuery
+this query is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MembershipProjectGrantQuery
+this query is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_grant_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MembershipProjectQuery
+this query is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### MembershipQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_query |  MembershipOrgQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_query |  MembershipProjectQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_grant_query |  MembershipProjectGrantQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.iam_query |  MembershipIAMQuery | - |  |
+
+
+
+
+### NickNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| nick_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### PersonalAccessToken
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+| scopes | repeated string | - |  |
+
+
+
+
+### Phone
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| phone |  string | - |  |
+| is_phone_verified |  bool | - |  |
+
+
+
+
+### Profile
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - |  |
+| last_name |  string | - |  |
+| nick_name |  string | - |  |
+| display_name |  string | - |  |
+| preferred_language |  string | - |  |
+| gender |  Gender | - |  |
+| avatar_url |  string | - |  |
+
+
+
+
+### RefreshToken
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| client_id |  string | - |  |
+| auth_time |  google.protobuf.Timestamp | - |  |
+| idle_expiration |  google.protobuf.Timestamp | - |  |
+| expiration |  google.protobuf.Timestamp | - |  |
+| scopes | repeated string | - |  |
+| audience | repeated string | - |  |
+
+
+
+
+### SearchQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_name_query |  UserNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query |  FirstNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query |  LastNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.nick_name_query |  NickNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query |  DisplayNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query |  EmailQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query |  StateQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.type_query |  TypeQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.login_name_query |  LoginNameQuery | - |  |
+
+
+
+
+### Session
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| session_id |  string | - |  |
+| agent_id |  string | - |  |
+| auth_state |  SessionState | - |  |
+| user_id |  string | - |  |
+| user_name |  string | - |  |
+| login_name |  string | - |  |
+| display_name |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| avatar_url |  string | - |  |
+
+
+
+
+### StateQuery
+UserStateQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| state |  UserState | - | enum.defined_only: true<br />  |
+
+
+
+
+### TypeQuery
+UserTypeQuery is always equals
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  Type | - | enum.defined_only: true<br />  |
+
+
+
+
+### User
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| state |  UserState | - |  |
+| user_name |  string | - |  |
+| login_names | repeated string | - |  |
+| preferred_login_name |  string | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.human |  Human | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) type.machine |  Machine | - |  |
+
+
+
+
+### UserGrant
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| role_keys | repeated string | - |  |
+| state |  UserGrantState | - |  |
+| user_id |  string | - |  |
+| user_name |  string | - |  |
+| first_name |  string | - |  |
+| last_name |  string | - |  |
+| email |  string | - | string.email: true<br />  |
+| display_name |  string | - | string.max_len: 200<br />  |
+| org_id |  string | - |  |
+| org_name |  string | - |  |
+| org_domain |  string | - |  |
+| project_id |  string | - |  |
+| project_name |  string | - |  |
+| project_grant_id |  string | - |  |
+| avatar_url |  string | - |  |
+| preferred_login_name |  string | - |  |
+
+
+
+
+### UserGrantDisplayNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| display_name |  string | - |  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantEmailQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantFirstNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantLastNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| last_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantOrgDomainQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_domain |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantOrgNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantProjectGrantIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_grant_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### UserGrantProjectIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### UserGrantProjectNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_id_query |  UserGrantProjectIDQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_id_query |  UserGrantUserIDQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.with_granted_query |  UserGrantWithGrantedQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.role_key_query |  UserGrantRoleKeyQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_grant_id_query |  UserGrantProjectGrantIDQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_name_query |  UserGrantUserNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.first_name_query |  UserGrantFirstNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.last_name_query |  UserGrantLastNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.email_query |  UserGrantEmailQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_name_query |  UserGrantOrgNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.org_domain_query |  UserGrantOrgDomainQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.project_name_query |  UserGrantProjectNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.display_name_query |  UserGrantDisplayNameQuery | - |  |
+| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.user_type_query |  UserGrantUserTypeQuery | - |  |
+
+
+
+
+### UserGrantRoleKeyQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| role_key |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantUserIDQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - | string.max_len: 200<br />  |
+
+
+
+
+### UserGrantUserNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### UserGrantUserTypeQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| type |  Type | - |  |
+
+
+
+
+### UserGrantWithGrantedQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| with_granted |  bool | - |  |
+
+
+
+
+### UserNameQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_name |  string | - | string.max_len: 200<br />  |
+| method |  zitadel.v1.TextQueryMethod | - | enum.defined_only: true<br />  |
+
+
+
+
+### WebAuthNKey
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| public_key |  bytes | - |  |
+
+
+
+
+### WebAuthNToken
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| state |  AuthFactorState | - |  |
+| name |  string | - |  |
+
+
+
+
+### WebAuthNVerification
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| public_key_credential |  bytes | - | bytes.min_len: 55<br />  |
+| token_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+
+
+
+
+
+
+## Enums
+
+
+### AccessTokenType {#accesstokentype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ACCESS_TOKEN_TYPE_BEARER | 0 | - |
+| ACCESS_TOKEN_TYPE_JWT | 1 | - |
+
+
+
+
+### AuthFactorState {#authfactorstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| AUTH_FACTOR_STATE_UNSPECIFIED | 0 | - |
+| AUTH_FACTOR_STATE_NOT_READY | 1 | - |
+| AUTH_FACTOR_STATE_READY | 2 | - |
+| AUTH_FACTOR_STATE_REMOVED | 3 | - |
+
+
+
+
+### Gender {#gender}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| GENDER_UNSPECIFIED | 0 | - |
+| GENDER_FEMALE | 1 | - |
+| GENDER_MALE | 2 | - |
+| GENDER_DIVERSE | 3 | - |
+
+
+
+
+### SessionState {#sessionstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SESSION_STATE_UNSPECIFIED | 0 | - |
+| SESSION_STATE_ACTIVE | 1 | - |
+| SESSION_STATE_TERMINATED | 2 | - |
+
+
+
+
+### Type {#type}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | - |
+| TYPE_HUMAN | 1 | - |
+| TYPE_MACHINE | 2 | - |
+
+
+
+
+### UserFieldName {#userfieldname}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| USER_FIELD_NAME_UNSPECIFIED | 0 | - |
+| USER_FIELD_NAME_USER_NAME | 1 | - |
+| USER_FIELD_NAME_FIRST_NAME | 2 | - |
+| USER_FIELD_NAME_LAST_NAME | 3 | - |
+| USER_FIELD_NAME_NICK_NAME | 4 | - |
+| USER_FIELD_NAME_DISPLAY_NAME | 5 | - |
+| USER_FIELD_NAME_EMAIL | 6 | - |
+| USER_FIELD_NAME_STATE | 7 | - |
+| USER_FIELD_NAME_TYPE | 8 | - |
+
+
+
+
+### UserGrantState {#usergrantstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| USER_GRANT_STATE_UNSPECIFIED | 0 | - |
+| USER_GRANT_STATE_ACTIVE | 1 | - |
+| USER_GRANT_STATE_INACTIVE | 2 | - |
+
+
+
+
+### UserState {#userstate}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| USER_STATE_UNSPECIFIED | 0 | - |
+| USER_STATE_ACTIVE | 1 | - |
+| USER_STATE_INACTIVE | 2 | - |
+| USER_STATE_DELETED | 3 | - |
+| USER_STATE_LOCKED | 4 | - |
+| USER_STATE_SUSPEND | 5 | - |
+| USER_STATE_INITIAL | 6 | - |
+
+
+
+

docs/docs/apis/proto/v1.md

@@ -0,0 +1,335 @@
+---
+title: zitadel/v1.proto
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+
+
+
+## Messages
+
+
+### AddCustomOrgIAMPolicyRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_id |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| user_login_must_be_domain |  bool | the username has to end with the domain of it's organisation (uniqueness is organisation based) |  |
+
+
+
+
+### DataAPIApplication
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| app_id |  string | - |  |
+| app |  zitadel.management.v1.AddAPIAppRequest | - |  |
+
+
+
+
+### DataAction
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| action_id |  string | - |  |
+| action |  zitadel.management.v1.CreateActionRequest | - |  |
+
+
+
+
+### DataAppKey
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| project_id |  string | - |  |
+| app_id |  string | - |  |
+| client_id |  string | - |  |
+| type |  zitadel.authn.v1.KeyType | - |  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+| public_key |  bytes | - |  |
+
+
+
+
+### DataHumanUser
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| user |  zitadel.management.v1.ImportHumanUserRequest | - |  |
+
+
+
+
+### DataJWTIDP
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| idp_id |  string | - |  |
+| idp |  zitadel.management.v1.AddOrgJWTIDPRequest | - |  |
+
+
+
+
+### DataMachineKey
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key_id |  string | - |  |
+| user_id |  string | - |  |
+| type |  zitadel.authn.v1.KeyType | - |  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+| public_key |  bytes | - |  |
+
+
+
+
+### DataMachineUser
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_id |  string | - |  |
+| user |  zitadel.management.v1.AddMachineUserRequest | - |  |
+
+
+
+
+### DataOIDCApplication
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| app_id |  string | - |  |
+| app |  zitadel.management.v1.AddOIDCAppRequest | - |  |
+
+
+
+
+### DataOIDCIDP
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| idp_id |  string | - |  |
+| idp |  zitadel.management.v1.AddOrgOIDCIDPRequest | - |  |
+
+
+
+
+### DataOrg
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| org_id |  string | - |  |
+| org |  zitadel.management.v1.AddOrgRequest | - |  |
+| iam_policy |  AddCustomOrgIAMPolicyRequest | - |  |
+| label_policy |  zitadel.management.v1.AddCustomLabelPolicyRequest | - |  |
+| lockout_policy |  zitadel.management.v1.AddCustomLockoutPolicyRequest | - |  |
+| login_policy |  zitadel.management.v1.AddCustomLoginPolicyRequest | - |  |
+| password_complexity_policy |  zitadel.management.v1.AddCustomPasswordComplexityPolicyRequest | - |  |
+| privacy_policy |  zitadel.management.v1.AddCustomPrivacyPolicyRequest | - |  |
+| projects | repeated DataProject | - |  |
+| project_roles | repeated zitadel.management.v1.AddProjectRoleRequest | - |  |
+| api_apps | repeated DataAPIApplication | - |  |
+| oidc_apps | repeated DataOIDCApplication | - |  |
+| human_users | repeated DataHumanUser | - |  |
+| machine_users | repeated DataMachineUser | - |  |
+| trigger_actions | repeated SetTriggerActionsRequest | - |  |
+| actions | repeated DataAction | - |  |
+| project_grants | repeated DataProjectGrant | - |  |
+| user_grants | repeated zitadel.management.v1.AddUserGrantRequest | - |  |
+| org_members | repeated zitadel.management.v1.AddOrgMemberRequest | - |  |
+| project_members | repeated zitadel.management.v1.AddProjectMemberRequest | - |  |
+| project_grant_members | repeated zitadel.management.v1.AddProjectGrantMemberRequest | - |  |
+| user_metadata | repeated zitadel.management.v1.SetUserMetadataRequest | - |  |
+| login_texts | repeated zitadel.management.v1.SetCustomLoginTextsRequest | - |  |
+| init_messages | repeated zitadel.management.v1.SetCustomInitMessageTextRequest | - |  |
+| password_reset_messages | repeated zitadel.management.v1.SetCustomPasswordResetMessageTextRequest | - |  |
+| verify_email_messages | repeated zitadel.management.v1.SetCustomVerifyEmailMessageTextRequest | - |  |
+| verify_phone_messages | repeated zitadel.management.v1.SetCustomVerifyPhoneMessageTextRequest | - |  |
+| domain_claimed_messages | repeated zitadel.management.v1.SetCustomDomainClaimedMessageTextRequest | - |  |
+| passwordless_registration_messages | repeated zitadel.management.v1.SetCustomPasswordlessRegistrationMessageTextRequest | - |  |
+| oidc_idps | repeated DataOIDCIDP | - |  |
+| jwt_idps | repeated DataJWTIDP | - |  |
+| second_factors | repeated zitadel.management.v1.AddSecondFactorToLoginPolicyRequest | - |  |
+| multi_factors | repeated zitadel.management.v1.AddMultiFactorToLoginPolicyRequest | - |  |
+| idps | repeated zitadel.management.v1.AddIDPToLoginPolicyRequest | - |  |
+| user_links | repeated zitadel.idp.v1.IDPUserLink | - |  |
+| domains | repeated zitadel.org.v1.Domain | - |  |
+| app_keys | repeated DataAppKey | - |  |
+| machine_keys | repeated DataMachineKey | - |  |
+
+
+
+
+### DataProject
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| project_id |  string | - |  |
+| project |  zitadel.management.v1.AddProjectRequest | - |  |
+
+
+
+
+### DataProjectGrant
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| grant_id |  string | - |  |
+| project_grant |  zitadel.management.v1.AddProjectGrantRequest | - |  |
+
+
+
+
+### ExportHumanUser
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| user_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| profile |  ExportHumanUser.Profile | - | message.required: true<br />  |
+| email |  ExportHumanUser.Email | - | message.required: true<br />  |
+| phone |  ExportHumanUser.Phone | - |  |
+| password |  string | - |  |
+| hashed_password |  ExportHumanUser.HashedPassword | - |  |
+| password_change_required |  bool | - |  |
+| request_passwordless_registration |  bool | - |  |
+| otp_code |  string | - |  |
+
+
+
+
+### ExportHumanUser.Email
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| email |  string | TODO: check if no value is allowed | string.email: true<br />  |
+| is_email_verified |  bool | - |  |
+
+
+
+
+### ExportHumanUser.HashedPassword
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| value |  string | - |  |
+| algorithm |  string | - |  |
+
+
+
+
+### ExportHumanUser.Phone
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| phone |  string | has to be a global number | string.min_len: 1<br /> string.max_len: 50<br /> string.prefix: +<br />  |
+| is_phone_verified |  bool | - |  |
+
+
+
+
+### ExportHumanUser.Profile
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| first_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| last_name |  string | - | string.min_len: 1<br /> string.max_len: 200<br />  |
+| nick_name |  string | - | string.max_len: 200<br />  |
+| display_name |  string | - | string.max_len: 200<br />  |
+| preferred_language |  string | - | string.max_len: 10<br />  |
+| gender |  zitadel.user.v1.Gender | - |  |
+
+
+
+
+### ImportDataOrg
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| orgs | repeated DataOrg | - |  |
+
+
+
+
+### SetTriggerActionsRequest
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| flow_type |  FlowType | - |  |
+| trigger_type |  TriggerType | - |  |
+| action_ids | repeated string | - |  |
+
+
+
+
+
+
+## Enums
+
+
+### FlowType {#flowtype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| FLOW_TYPE_UNSPECIFIED | 0 | - |
+| FLOW_TYPE_EXTERNAL_AUTHENTICATION | 1 | - |
+
+
+
+
+### TriggerType {#triggertype}
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TRIGGER_TYPE_UNSPECIFIED | 0 | - |
+| TRIGGER_TYPE_POST_AUTHENTICATION | 1 | - |
+| TRIGGER_TYPE_PRE_CREATION | 2 | - |
+| TRIGGER_TYPE_POST_CREATION | 3 | - |
+
+
+
+

e2e/config/host.docker.internal/zitadel.yaml

@@ -1,6 +1,11 @@
 Log:
   Level: info
 
+Telemetry:
+  Enabled: true
+  Endpoints:
+    - https://httpbin.org/post
+
 ExternalDomain: host.docker.internal
 ExternalSecure: false
 
@@ -42,6 +47,8 @@ Projections:
   Customizations:
     NotificationsQuotas:
       RequeueEvery: 1s
+    Telemetry:
+      RequeueEvery: 1s
 
 DefaultInstance:
   LoginPolicy:

e2e/config/localhost/zitadel.yaml

@@ -1,6 +1,11 @@
 Log:
   Level: info
 
+Telemetry:
+  Enabled: true
+  Endpoints:
+    - https://httpbin.org/post
+
 ExternalDomain: localhost
 ExternalSecure: false
 
@@ -42,6 +47,8 @@ Projections:
   Customizations:
     NotificationsQuotas:
       RequeueEvery: 1s
+    Telemetry:
+      RequeueEvery: 1s
 
 DefaultInstance:
   LoginPolicy:

internal/command/command.go

@@ -5,6 +5,8 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/zitadel/zitadel/internal/repository/milestone"
+
 	"github.com/zitadel/zitadel/internal/api/authz"
 	api_http "github.com/zitadel/zitadel/internal/api/http"
 	"github.com/zitadel/zitadel/internal/command/preparation"
@@ -124,6 +126,7 @@ func StartCommands(
 	quota.RegisterEventMappers(repo.eventstore)
 	session.RegisterEventMappers(repo.eventstore)
 	idpintent.RegisterEventMappers(repo.eventstore)
+	milestone.RegisterEventMappers(repo.eventstore)
 
 	repo.userPasswordAlg = crypto.NewBCrypt(defaults.SecretGenerators.PasswordSaltCost)
 	repo.machineKeySize = int(defaults.SecretGenerators.MachineKeySize)

internal/command/telemetry.go

@@ -3,25 +3,23 @@ package command
 import (
 	"context"
 
-	"github.com/zitadel/zitadel/internal/repository/milestone"
-
 	"github.com/zitadel/zitadel/internal/eventstore"
+
+	"github.com/zitadel/zitadel/internal/repository/milestone"
 )
 
-// ReportTelemetryUsage writes one or many *telemetry.PushDueEvent directly to the eventstore
+// ReportMilestoneReached writes each *milestone.ReachedEvent directly to the event store
-func (c *Commands) ReportTelemetryUsage(ctx context.Context, dueEvent ...*milestone.ReachedEvent) error {
+func (c *Commands) ReportMilestoneReached(ctx context.Context, triggeringEvent eventstore.Event, customContext interface{}) error {
-	cmds := make([]eventstore.Command, len(dueEvent))
+	aggregateId, err := c.idGenerator.Next()
-	for idx, notification := range dueEvent {
+	if err != nil {
-		cmds[idx] = notification
+		return err
 	}
-	_, err := c.eventstore.Push(ctx, cmds...)
+	_, err = c.eventstore.Push(ctx, milestone.NewReachedEvent(ctx, aggregateId, triggeringEvent, customContext))
 	return err
 }
 
-func (c *Commands) TelemetryPushed(ctx context.Context, dueEvent *milestone.ReachedEvent, endpoints []string) error {
+// ReportMilestonePushed defers a milestone.PushedEvent for each *milestone.ReachedEvent and writes it directly to the event store.
-	_, err := c.eventstore.Push(
+func (c *Commands) ReportMilestonePushed(ctx context.Context, endpoints []string, reachedEvent *milestone.ReachedEvent) error {
-		ctx,
+	_, err := c.eventstore.Push(ctx, milestone.NewPushedEvent(ctx, reachedEvent, endpoints))
-		milestone.NewPushedEvent(ctx, dueEvent, endpoints),
-	)
 	return err
 }

internal/notification/handlers/telemetrypusher.go

@@ -27,12 +27,12 @@ type TelemetryPusherConfig struct {
 }
 
 type telemetryPusher struct {
-	cfg TelemetryPusherConfig
 	crdb.StatementHandler
 	commands                       *command.Commands
 	queries                        *NotificationQueries
 	metricSuccessfulDeliveriesJSON string
 	metricFailedDeliveriesJSON     string
+	endpoints                      []string
 }
 
 func NewTelemetryPusher(
@@ -46,8 +46,11 @@ func NewTelemetryPusher(
 ) *telemetryPusher {
 	p := new(telemetryPusher)
 	handlerCfg.ProjectionName = TelemetryProjectionTable
-	handlerCfg.Reducers = p.reducers()
+	handlerCfg.Reducers = []handler.AggregateReducer{{}}
-	p.cfg = telemetryCfg
+	if telemetryCfg.Enabled {
+		handlerCfg.Reducers = p.reducers()
+	}
+	p.endpoints = telemetryCfg.Endpoints
 	p.StatementHandler = crdb.NewStatementHandler(ctx, handlerCfg)
 	p.commands = commands
 	p.queries = queries
@@ -58,23 +61,20 @@ func NewTelemetryPusher(
 }
 
 func (t *telemetryPusher) reducers() []handler.AggregateReducer {
-	if !t.cfg.Enabled {
-		return nil
-	}
 	return []handler.AggregateReducer{
 		{
 			Aggregate: milestone.AggregateType,
 			EventRedusers: []handler.EventReducer{
 				{
 					Event:  milestone.ReachedEventType,
-					Reduce: t.reduceTelemetryPushDue,
+					Reduce: t.reduceMilestoneReached,
 				},
 			},
 		},
 	}
 }
 
-func (t *telemetryPusher) reduceTelemetryPushDue(event eventstore.Event) (*handler.Statement, error) {
+func (t *telemetryPusher) reduceMilestoneReached(event eventstore.Event) (*handler.Statement, error) {
 	e, ok := event.(*milestone.ReachedEvent)
 	if !ok {
 		return nil, errors.ThrowInvalidArgumentf(nil, "HANDL-UjA3E", "reduce.wrong.event.type %s", milestone.ReachedEventType)
@@ -87,7 +87,7 @@ func (t *telemetryPusher) reduceTelemetryPushDue(event eventstore.Event) (*handl
 	if alreadyHandled {
 		return crdb.NewNoOpStatement(e), nil
 	}
-	for _, endpoint := range t.cfg.Endpoints {
+	for _, endpoint := range t.endpoints {
 		if err = types.SendJSON(
 			ctx,
 			webhook.Config{
@@ -105,7 +105,7 @@ func (t *telemetryPusher) reduceTelemetryPushDue(event eventstore.Event) (*handl
 		}
 	}
 
-	err = t.commands.TelemetryPushed(ctx, e, t.cfg.Endpoints)
+	err = t.commands.ReportMilestonePushed(ctx, t.endpoints, e)
 	if err != nil {
 		return nil, err
 	}

internal/notification/handlers/usernotifier.go

@@ -2,13 +2,8 @@ package handlers
 
 import (
 	"context"
-	"fmt"
 	"time"
 
-	"github.com/zitadel/zitadel/internal/repository/project"
-
-	"github.com/zitadel/zitadel/internal/repository/instance"
-
 	"github.com/zitadel/zitadel/internal/command"
 	"github.com/zitadel/zitadel/internal/crypto"
 	"github.com/zitadel/zitadel/internal/domain"
@@ -111,67 +106,11 @@ func (u *userNotifier) reducers() []handler.AggregateReducer {
 					Event:  user.HumanPasswordChangedType,
 					Reduce: u.reducePasswordChanged,
 				},
-				{
-					Event:  user.UserTokenAddedType,
-					Reduce: u.reduceUserTokenAdded,
-				},
-			},
-		},
-		{
-			Aggregate: instance.AggregateType,
-			EventRedusers: []handler.EventReducer{
-				{
-					Event:  instance.InstanceAddedEventType,
-					Reduce: u.reduceInstanceAdded,
-				},
-				{
-					Event:  instance.InstanceRemovedEventType,
-					Reduce: u.reduceInstanceRemoved,
-				},
-			},
-		},
-		{
-			Aggregate: project.AggregateType,
-			EventRedusers: []handler.EventReducer{
-				{
-					Event:  project.ProjectAddedType,
-					Reduce: u.reduceProjectAdded,
-				},
-				{
-					Event:  project.ApplicationAddedType,
-					Reduce: u.reduceApplicationAdded,
-				},
 			},
 		},
 	}
 }
 
-func (u *userNotifier) reduceInstanceAdded(event eventstore.Event) (*handler.Statement, error) {
-	fmt.Println("reduceInstanceAdded")
-	return crdb.NewNoOpStatement(event), nil
-}
-
-func (u *userNotifier) reduceProjectAdded(event eventstore.Event) (*handler.Statement, error) {
-	// ignore instance.ProjectSetEventType
-	fmt.Println("reduceProjectAdded")
-	return crdb.NewNoOpStatement(event), nil
-}
-
-func (u *userNotifier) reduceApplicationAdded(event eventstore.Event) (*handler.Statement, error) {
-	fmt.Println("reduceApplicationAdded")
-	return crdb.NewNoOpStatement(event), nil
-}
-
-func (u *userNotifier) reduceUserTokenAdded(event eventstore.Event) (*handler.Statement, error) {
-	fmt.Println("reduceUserTokenAdded")
-	return crdb.NewNoOpStatement(event), nil
-}
-
-func (u *userNotifier) reduceInstanceRemoved(event eventstore.Event) (*handler.Statement, error) {
-	fmt.Println("reduceInstanceRemoved")
-	return crdb.NewNoOpStatement(event), nil
-}
-
 func (u *userNotifier) reduceInitCodeAdded(event eventstore.Event) (*handler.Statement, error) {
 	e, ok := event.(*user.HumanInitialCodeAddedEvent)
 	if !ok {

internal/query/projection/milestones.go

@@ -0,0 +1,169 @@
+package projection
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/zitadel/zitadel/internal/repository/project"
+	"github.com/zitadel/zitadel/internal/repository/user"
+
+	"github.com/zitadel/zitadel/internal/repository/milestone"
+
+	"github.com/zitadel/zitadel/internal/errors"
+	"github.com/zitadel/zitadel/internal/eventstore"
+	"github.com/zitadel/zitadel/internal/eventstore/handler"
+	"github.com/zitadel/zitadel/internal/eventstore/handler/crdb"
+	"github.com/zitadel/zitadel/internal/repository/instance"
+)
+
+const (
+	MilestonesProjectionTable = "projections.milestones"
+
+	MilestoneColumnInstanceID    = "instance_id"
+	MilestoneColumnMilestoneType = "milestone_type"
+	MilestoneColumnReachedAt     = "reached_at"
+	MilestoneColumnPushedAt      = "pushed_at"
+	MilestoneColumnPrimaryDomain = "primary_domain"
+)
+
+type milestoneProjection struct {
+	crdb.StatementHandler
+}
+
+func newMilestoneInstanceProjection(ctx context.Context, config crdb.StatementHandlerConfig) *milestoneProjection {
+	p := new(milestoneProjection)
+	config.ProjectionName = MilestonesProjectionTable
+	config.Reducers = p.reducers()
+	config.InitCheck = crdb.NewMultiTableCheck(
+		crdb.NewTable([]*crdb.Column{
+			crdb.NewColumn(MilestoneColumnInstanceID, crdb.ColumnTypeText),
+			crdb.NewColumn(MilestoneColumnMilestoneType, crdb.ColumnTypeEnum),
+			crdb.NewColumn(MilestoneColumnReachedAt, crdb.ColumnTypeTimestamp, crdb.Nullable()),
+			crdb.NewColumn(MilestoneColumnPushedAt, crdb.ColumnTypeTimestamp, crdb.Nullable()),
+			crdb.NewColumn(MilestoneColumnPrimaryDomain, crdb.ColumnTypeText, crdb.Nullable()),
+		},
+			crdb.NewPrimaryKey(MilestoneColumnInstanceID, MilestoneColumnMilestoneType),
+		),
+	)
+	p.StatementHandler = crdb.NewStatementHandler(ctx, config)
+	return p
+}
+
+func (p *milestoneProjection) reducers() []handler.AggregateReducer {
+	return []handler.AggregateReducer{
+		{
+			Aggregate: instance.AggregateType,
+			EventRedusers: []handler.EventReducer{
+				{
+					Event:  instance.InstanceAddedEventType,
+					Reduce: p.reduceInstanceAdded,
+				},
+				{
+					Event:  instance.InstanceDomainPrimarySetEventType,
+					Reduce: p.reduceInstanceDomainPrimarySet,
+				},
+				{
+					Event:  instance.InstanceRemovedEventType,
+					Reduce: p.reduceInstanceRemoved,
+				},
+			},
+		},
+		{
+			Aggregate: project.AggregateType,
+			EventRedusers: []handler.EventReducer{
+				{
+					Event:  project.ProjectAddedType,
+					Reduce: p.reduceProjectAdded,
+				},
+				{
+					Event:  project.ApplicationAddedType,
+					Reduce: p.reduceApplicationAdded,
+				},
+			},
+		},
+		{
+			Aggregate: user.AggregateType,
+			EventRedusers: []handler.EventReducer{
+				{
+					Event:  user.UserTokenAddedType,
+					Reduce: p.reduceUserTokenAdded,
+				},
+			},
+		},
+		{
+			Aggregate: milestone.AggregateType,
+			EventRedusers: []handler.EventReducer{
+				{
+					Event:  milestone.PushedEventType,
+					Reduce: p.milestonePushed,
+				},
+			},
+		},
+	}
+}
+
+func (p *milestoneProjection) reduceInstanceDomainPrimarySet(event eventstore.Event) (*handler.Statement, error) {
+	e, ok := event.(*instance.DomainPrimarySetEvent)
+	if !ok {
+		return nil, errors.ThrowInvalidArgumentf(nil, "HANDL-Sfrgf", "reduce.wrong.event.type %s", instance.InstanceDomainPrimarySetEventType)
+	}
+
+	var statements []func(eventstore.Event) crdb.Exec
+	for _, ms := range milestone.All() {
+		statements = append(statements, crdb.AddUpsertStatement(
+			[]handler.Column{
+				handler.NewCol(MilestoneColumnInstanceID, nil),
+				handler.NewCol(MilestoneColumnMilestoneType, nil),
+			},
+			[]handler.Column{
+				handler.NewCol(MilestoneColumnInstanceID, e.Aggregate().InstanceID),
+				handler.NewCol(MilestoneColumnMilestoneType, ms),
+				handler.NewCol(MilestoneColumnPrimaryDomain, e.Domain),
+			},
+		))
+	}
+
+	return crdb.NewMultiStatement(e, statements...), nil
+}
+
+func (p *milestoneProjection) reduceInstanceAdded(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func (p *milestoneProjection) reduceProjectAdded(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+	// ignore instance.ProjectSetEventType
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func (p *milestoneProjection) reduceApplicationAdded(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func (p *milestoneProjection) reduceUserTokenAdded(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func (p *milestoneProjection) reduceInstanceRemoved(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func (p *milestoneProjection) milestonePushed(event eventstore.Event) (*handler.Statement, error) {
+	printEvent(event)
+	return crdb.NewNoOpStatement(event), nil
+}
+
+func printEvent(event eventstore.Event) {
+	var pretty bytes.Buffer
+	if err := json.Indent(&pretty, event.DataAsBytes(), "", "    "); err != nil {
+		panic(err)
+	}
+	fmt.Println(event.Type(), pretty.String())
+}

internal/repository/milestone/events.go

@@ -1,8 +1,11 @@
+//go:
+
 package milestone
 
 import (
 	"context"
 	"encoding/json"
+	"time"
 
 	"github.com/zitadel/zitadel/internal/errors"
 	"github.com/zitadel/zitadel/internal/eventstore"
@@ -10,57 +13,16 @@ import (
 )
 
 const (
-	eventTypePrefix  = eventstore.EventType("milestone.")
+	eventTypePrefix = eventstore.EventType("milestone.")
-	ReachedEventType = eventTypePrefix + "reached"
+	PushedEventType = eventTypePrefix + "pushed"
-	PushedEventType  = eventTypePrefix + "pushed"
 )
 
-type ReachedEvent struct {
-	eventstore.BaseEvent `json:"-"`
-	MilestoneEvent       SerializableEvent `json:"milestoneEvent"`
-}
-
-func (n *ReachedEvent) Data() interface{} {
-	return n
-}
-
-func (n *ReachedEvent) UniqueConstraints() []*eventstore.EventUniqueConstraint {
-	return nil
-}
-
-func NewReachedEvent(
-	ctx context.Context,
-	newAggregateID string,
-	milestoneEvent eventstore.BaseEvent,
-) *ReachedEvent {
-	triggeringEventsAggregate := milestoneEvent.Aggregate()
-	return &ReachedEvent{
-		BaseEvent: *eventstore.NewBaseEventForPush(
-			ctx,
-			&newAggregate(newAggregateID, triggeringEventsAggregate.InstanceID, triggeringEventsAggregate.ResourceOwner).Aggregate,
-			ReachedEventType,
-		),
-		MilestoneEvent: newSerializableEvent(milestoneEvent),
-	}
-}
-
-func ReachedEventMapper(event *repository.Event) (eventstore.Event, error) {
-	e := &ReachedEvent{
-		BaseEvent: *eventstore.BaseEventFromRepo(event),
-	}
-
-	err := json.Unmarshal(event.Data, e)
-	if err != nil {
-		return nil, errors.ThrowInternal(err, "QUOTA-k56rT", "unable to unmarshal milestone reached")
-	}
-
-	return e, nil
-}
-
 type PushedEvent struct {
 	eventstore.BaseEvent `json:"-"`
-	ReachedEventSequence uint64   `json:"reachedEventSequence"`
+	Milestone            Milestone `json:"milestone"`
-	Endpoints            []string `json:"endpoints"`
+	Reached              time.Time `json:"reached"`
+	Endpoints            []string  `json:"endpoints"`
+	PrimaryDomain        string    `json:"primaryDomain"`
 }
 
 func (e *PushedEvent) Data() interface{} {
@@ -73,18 +35,22 @@ func (e *PushedEvent) UniqueConstraints() []*eventstore.EventUniqueConstraint {
 
 func NewPushedEvent(
 	ctx context.Context,
-	reachedEvent *ReachedEvent,
+	newAggregate *Aggregate,
+	milestone Milestone,
+	reached time.Time,
 	endpoints []string,
+	primaryDomain string,
 ) *PushedEvent {
-	aggregate := reachedEvent.Aggregate()
 	return &PushedEvent{
 		BaseEvent: *eventstore.NewBaseEventForPush(
 			ctx,
-			&aggregate,
+			&newAggregate.Aggregate,
 			PushedEventType,
 		),
-		ReachedEventSequence: reachedEvent.Sequence(),
+		Milestone:     milestone,
-		Endpoints:            endpoints,
+		Reached:       reached,
+		Endpoints:     endpoints,
+		PrimaryDomain: primaryDomain,
 	}
 }
 
@@ -92,11 +58,9 @@ func PushedEventMapper(event *repository.Event) (eventstore.Event, error) {
 	e := &PushedEvent{
 		BaseEvent: *eventstore.BaseEventFromRepo(event),
 	}
-
 	err := json.Unmarshal(event.Data, e)
 	if err != nil {
 		return nil, errors.ThrowInternal(err, "QUOTA-4n8vs", "unable to unmarshal milestone pushed")
 	}
-
 	return e, nil
 }

internal/repository/milestone/milestone_string.go

@@ -0,0 +1,30 @@
+// Code generated by "stringer -type=Milestone"; DO NOT EDIT.
+
+package milestone
+
+import "strconv"
+
+func _() {
+	// An "invalid array index" compiler error signifies that the constant values have changed.
+	// Re-run the stringer command to generate them again.
+	var x [1]struct{}
+	_ = x[unknown-0]
+	_ = x[InstanceCreated-1]
+	_ = x[AuthenticationSucceededOnInstance-2]
+	_ = x[ProjectCreated-3]
+	_ = x[ApplicationCreated-4]
+	_ = x[AuthenticationSucceededOnApplication-5]
+	_ = x[InstanceDeleted-6]
+	_ = x[milestonesCount-7]
+}
+
+const _Milestone_name = "unknownInstanceCreatedAuthenticationSucceededOnInstanceProjectCreatedApplicationCreatedAuthenticationSucceededOnApplicationInstanceDeletedmilestonesCount"
+
+var _Milestone_index = [...]uint8{0, 7, 22, 55, 69, 87, 123, 138, 153}
+
+func (i Milestone) String() string {
+	if i < 0 || i >= Milestone(len(_Milestone_index)-1) {
+		return "Milestone(" + strconv.FormatInt(int64(i), 10) + ")"
+	}
+	return _Milestone_name[_Milestone_index[i]:_Milestone_index[i+1]]
+}

internal/repository/milestone/milestones.go

@@ -0,0 +1,25 @@
+//go:generate stringer -type=Milestone
+
+package milestone
+
+type Milestone int
+
+const (
+	unknown Milestone = iota
+	InstanceCreated
+	AuthenticationSucceededOnInstance
+	ProjectCreated
+	ApplicationCreated
+	AuthenticationSucceededOnApplication
+	InstanceDeleted
+
+	milestonesCount
+)
+
+func All() []Milestone {
+	milestones := make([]Milestone, milestonesCount-1)
+	for i := 1; i < int(milestonesCount); i++ {
+		milestones[i] = Milestone(i)
+	}
+	return milestones
+}

internal/repository/milestone/serializable_event.go

@@ -1,15 +0,0 @@
-package milestone
-
-import "github.com/zitadel/zitadel/internal/eventstore"
-
-type SerializableEvent struct {
-	eventstore.BaseEvent `json:",inline"`
-	Data                 []byte `json:"data"`
-}
-
-func newSerializableEvent(triggeringEvent eventstore.BaseEvent) SerializableEvent {
-	return SerializableEvent{
-		BaseEvent: triggeringEvent,
-		Data:      triggeringEvent.DataAsBytes(),
-	}
-}