docs: api request descriptions (#1637)

* doc: api descriptions * doc: management description * doc: message validation * doc: api descriptions * doc: api descriptions * doc: description * doc: index images * doc: design * colors, colors and more colors * margin * fix comment * doc: api descriptions * doc: empty response * doc: api descriptions * fix comment Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2025-12-05 10:52:04 +00:00 · 2021-04-22 14:59:17 +02:00
parent 8f61117805
commit 12f128e3c5
36 changed files with 5523 additions and 2652 deletions
--- a/docs/docs/apis/apis.md
+++ b/docs/docs/apis/apis.md
@@ -14,6 +14,7 @@ The easiest way to have a look at them is, to import them in the [Swagger Editor
 ## Authentication API aka Auth

 The authentication API (aka Auth API) is used for all operations on the currently logged in user.
+The user id is taken from the sub claim in the token.

 | Service | URI                                                                                                                         |
 |:--------|:----------------------------------------------------------------------------------------------------------------------------|
@@ -29,6 +30,7 @@ The authentication API (aka Auth API) is used for all operations on the currentl
 ## Management API

 The management API is as the name states the interface where systems can mutate IAM objects like, organisations, projects, clients, users and so on if they have the necessary access rights.
+To identify the current organisation you can send a header `x-zitadel-orgid` or if no header is set, the organisation of the authenticated user is set.

 | Service | URI                                                                                                                                                 |
 |:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------|
--- a/docs/docs/apis/proto/admin.md
+++ b/docs/docs/apis/proto/admin.md
--- a/docs/docs/apis/proto/app.md
+++ b/docs/docs/apis/proto/app.md
@@ -6,6 +6,88 @@ title: zitadel/app.proto



+## Messages
+
+
+### APIConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| client_id |  string | - |  |
+| client_secret |  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 | - |  |
+
+
+
+
+### 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 | - |  |
+| client_secret |  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 | - |  |
+
+
+
+


 ## Enums
--- a/docs/docs/apis/proto/auth.md
+++ b/docs/docs/apis/proto/auth.md
--- a/docs/docs/apis/proto/auth_n_key.md
+++ b/docs/docs/apis/proto/auth_n_key.md
@@ -6,6 +6,23 @@ title: zitadel/auth_n_key.proto



+## Messages
+
+
+### Key
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| type |  KeyType | - |  |
+| expiration_date |  google.protobuf.Timestamp | - |  |
+
+
+
+


 ## Enums
--- a/docs/docs/apis/proto/change.md
+++ b/docs/docs/apis/proto/change.md
@@ -6,5 +6,37 @@ title: zitadel/change.proto



+## 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 | - |  |
+
+
+
+
+### ChangeQuery
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| sequence |  uint64 | sequence represents the order of events. It's always upcounting |  |
+| limit |  uint32 | - |  |
+| asc |  bool | - |  |
+
+
+
+


--- a/docs/docs/apis/proto/idp.md
+++ b/docs/docs/apis/proto/idp.md
@@ -6,6 +6,104 @@ title: zitadel/idp.proto



+## 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### OIDCConfig
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| client_id |  string | - |  |
+| issuer |  string | - |  |
+| scopes | repeated string | - |  |
+| display_name_mapping |  OIDCMappingField | - |  |
+| username_mapping |  OIDCMappingField | - |  |
+
+
+
+


 ## Enums
--- a/docs/docs/apis/proto/management.md
+++ b/docs/docs/apis/proto/management.md
--- a/docs/docs/apis/proto/member.md
+++ b/docs/docs/apis/proto/member.md
@@ -6,5 +6,87 @@ title: zitadel/member.proto



+## 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 | - |  |
+
+
+
+
+### 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 />  |
+
+
+
+


--- a/docs/docs/apis/proto/message.md
+++ b/docs/docs/apis/proto/message.md
@@ -6,5 +6,32 @@ title: zitadel/message.proto



+## Messages
+
+
+### ErrorDetail
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| id |  string | - |  |
+| message |  string | - |  |
+
+
+
+
+### LocalizedMessage
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| key |  string | - |  |
+| localized_message |  string | - |  |
+
+
+
+


--- a/docs/docs/apis/proto/object.md
+++ b/docs/docs/apis/proto/object.md
@@ -6,6 +6,61 @@ title: zitadel/object.proto



+## 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
--- a/docs/docs/apis/proto/options.md
+++ b/docs/docs/apis/proto/options.md
@@ -6,5 +6,21 @@ title: zitadel/options.proto



+## Messages
+
+
+### AuthOption
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| permission |  string | - |  |
+| check_field_name |  string | - |  |
+| feature |  string | - |  |
+
+
+
+


--- a/docs/docs/apis/proto/org.md
+++ b/docs/docs/apis/proto/org.md
@@ -6,6 +6,99 @@ title: zitadel/org.proto



+## 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 | - |  |
+
+
+
+


 ## Enums
--- a/docs/docs/apis/proto/policy.md
+++ b/docs/docs/apis/proto/policy.md
@@ -6,6 +6,99 @@ title: zitadel/policy.proto



+## Messages
+
+
+### LabelPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| primary_color |  string | - |  |
+| secondary_color |  string | - |  |
+| is_default |  bool | - |  |
+| hide_login_name_suffix |  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 | - |  |
+
+
+
+
+### OrgIAMPolicy
+
+
+
+| 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 | - |  |
+
+
+
+
+### PasswordLockoutPolicy
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| details |  zitadel.v1.ObjectDetails | - |  |
+| max_attempts |  uint64 | - |  |
+| show_lockout_failure |  bool | - |  |
+| is_default |  bool | - |  |
+
+
+
+


 ## Enums
--- a/docs/docs/apis/proto/project.md
+++ b/docs/docs/apis/proto/project.md
@@ -6,6 +6,154 @@ title: zitadel/project.proto



+## Messages
+
+
+### 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 />  |
+
+
+
+
+### 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 |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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
--- a/docs/docs/apis/proto/user.md
+++ b/docs/docs/apis/proto/user.md
@@ -6,6 +6,566 @@ title: zitadel/user.proto



+## 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 />  |
+
+
+
+
+### Machine
+
+
+
+| Field | Type | Description | Validation |
+| ----- | ---- | ----------- | ----------- |
+| name |  string | - |  |
+| description |  string | - |  |
+
+
+
+
+### 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 />  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 | - |  |
+
+
+
+
+### 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 />  |
+
+
+
+
+### 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