Skip to main content

zitadel/management.proto

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

ManagementService‚Äč

Healthz‚Äč

rpc Healthz(HealthzRequest) HealthzResponse

GET: /healthz

GetOIDCInformation‚Äč

rpc GetOIDCInformation(GetOIDCInformationRequest) GetOIDCInformationResponse

GET: /zitadel/docs

GetIAM‚Äč

rpc GetIAM(GetIAMRequest) GetIAMResponse

Returns some needed settings of the IAM (Global Organisation ID, Zitadel Project ID)

GET: /iam

GetSupportedLanguages‚Äč

rpc GetSupportedLanguages(GetSupportedLanguagesRequest) GetSupportedLanguagesResponse

Returns the default languages

GET: /languages

GetUserByID‚Äč

rpc GetUserByID(GetUserByIDRequest) GetUserByIDResponse

Returns the requested full blown user (human or machine)

GET: /users/{id}

GetUserByLoginNameGlobal‚Äč

rpc GetUserByLoginNameGlobal(GetUserByLoginNameGlobalRequest) GetUserByLoginNameGlobalResponse

Searches a user over all organisations the login name has to match exactly

GET: /global/users/_by_login_name

ListUsers‚Äč

rpc ListUsers(ListUsersRequest) ListUsersResponse

Return the users matching the query Limit should always be set, there is a default limit set by the service

POST: /users/_search

ListUserChanges‚Äč

rpc ListUserChanges(ListUserChangesRequest) ListUserChangesResponse

Returns the history of the user (each event) Limit should always be set, there is a default limit set by the service

POST: /users/{user_id}/changes/_search

IsUserUnique‚Äč

rpc IsUserUnique(IsUserUniqueRequest) IsUserUniqueResponse

Returns if a user with the searched email or username is unique

GET: /users/_is_unique

AddHumanUser‚Äč

rpc AddHumanUser(AddHumanUserRequest) AddHumanUserResponse

Create a user of the type human A email will be sent to the user if email is not verified or no password is set If a password is given, the user has to change on the next login

POST: /users/human

ImportHumanUser‚Äč

rpc ImportHumanUser(ImportHumanUserRequest) ImportHumanUserResponse

Create a user of the type human A email will be sent to the user if email is not verified or no password is set If a password is given, the user doesn't have to change on the next login

POST: /users/human/_import

AddMachineUser‚Äč

rpc AddMachineUser(AddMachineUserRequest) AddMachineUserResponse

Create a user of the type machine

POST: /users/machine

DeactivateUser‚Äč

rpc DeactivateUser(DeactivateUserRequest) DeactivateUserResponse

Changes the user state to deactivated The user will not be able to login returns an error if user state is already deactivated

POST: /users/{id}/_deactivate

ReactivateUser‚Äč

rpc ReactivateUser(ReactivateUserRequest) ReactivateUserResponse

Changes the user state to active returns an error if user state is not deactivated

POST: /users/{id}/_reactivate

LockUser‚Äč

rpc LockUser(LockUserRequest) LockUserResponse

Changes the user state to deactivated The user will not be able to login returns an error if user state is already locked

POST: /users/{id}/_lock

UnlockUser‚Äč

rpc UnlockUser(UnlockUserRequest) UnlockUserResponse

Changes the user state to active returns an error if user state is not locked

POST: /users/{id}/_unlock

RemoveUser‚Äč

rpc RemoveUser(RemoveUserRequest) RemoveUserResponse

Changes the user state to deleted

DELETE: /users/{id}

UpdateUserName‚Äč

rpc UpdateUserName(UpdateUserNameRequest) UpdateUserNameResponse

Changes the username

PUT: /users/{user_id}/username

SetUserMetadata‚Äč

rpc SetUserMetadata(SetUserMetadataRequest) SetUserMetadataResponse

Sets a user metadata by key

POST: /users/{id}/metadata/{key}

BulkSetUserMetadata‚Äč

rpc BulkSetUserMetadata(BulkSetUserMetadataRequest) BulkSetUserMetadataResponse

Set a list of user metadata

POST: /users/{id}/metadata/_bulk

ListUserMetadata‚Äč

rpc ListUserMetadata(ListUserMetadataRequest) ListUserMetadataResponse

Returns the user metadata

POST: /users/{id}/metadata/_search

GetUserMetadata‚Äč

rpc GetUserMetadata(GetUserMetadataRequest) GetUserMetadataResponse

Returns the user metadata by key

GET: /users/{id}/metadata/{key}

RemoveUserMetadata‚Äč

rpc RemoveUserMetadata(RemoveUserMetadataRequest) RemoveUserMetadataResponse

Removes a user metadata by key

DELETE: /users/{id}/metadata/{key}

BulkRemoveUserMetadata‚Äč

rpc BulkRemoveUserMetadata(BulkRemoveUserMetadataRequest) BulkRemoveUserMetadataResponse

Set a list of user metadata

DELETE: /users/{id}/metadata/_bulk

GetHumanProfile‚Äč

rpc GetHumanProfile(GetHumanProfileRequest) GetHumanProfileResponse

Returns the profile of the human

GET: /users/{user_id}/profile

UpdateHumanProfile‚Äč

rpc UpdateHumanProfile(UpdateHumanProfileRequest) UpdateHumanProfileResponse

Changes the profile of the human

PUT: /users/{user_id}/profile

GetHumanEmail‚Äč

rpc GetHumanEmail(GetHumanEmailRequest) GetHumanEmailResponse

GetHumanEmail returns the email and verified state of the human

GET: /users/{user_id}/email

UpdateHumanEmail‚Äč

rpc UpdateHumanEmail(UpdateHumanEmailRequest) UpdateHumanEmailResponse

Changes the email of the human If state is not verified, the user will get a verification email

PUT: /users/{user_id}/email

ResendHumanInitialization‚Äč

rpc ResendHumanInitialization(ResendHumanInitializationRequest) ResendHumanInitializationResponse

Resends an email to the given email address to finish the initialization process of the user Changes the email address of the user if it is provided

POST: /users/{user_id}/_resend_initialization

ResendHumanEmailVerification‚Äč

rpc ResendHumanEmailVerification(ResendHumanEmailVerificationRequest) ResendHumanEmailVerificationResponse

Resends an email to the given email address to finish the email verification process of the user

POST: /users/{user_id}/email/_resend_verification

GetHumanPhone‚Äč

rpc GetHumanPhone(GetHumanPhoneRequest) GetHumanPhoneResponse

Returns the phone and verified state of the human phone

GET: /users/{user_id}/phone

UpdateHumanPhone‚Äč

rpc UpdateHumanPhone(UpdateHumanPhoneRequest) UpdateHumanPhoneResponse

Changes the phone number If verified is not set, the user will get an sms to verify the number

PUT: /users/{user_id}/phone

RemoveHumanPhone‚Äč

rpc RemoveHumanPhone(RemoveHumanPhoneRequest) RemoveHumanPhoneResponse

Removes the phone number of the human

DELETE: /users/{user_id}/phone

ResendHumanPhoneVerification‚Äč

rpc ResendHumanPhoneVerification(ResendHumanPhoneVerificationRequest) ResendHumanPhoneVerificationResponse

An sms will be sent to the given phone number to finish the phone verification process of the user

POST: /users/{user_id}/phone/_resend_verification

RemoveHumanAvatar‚Äč

rpc RemoveHumanAvatar(RemoveHumanAvatarRequest) RemoveHumanAvatarResponse

Removes the avatar number of the human

DELETE: /users/{user_id}/avatar

SetHumanInitialPassword‚Äč

rpc SetHumanInitialPassword(SetHumanInitialPasswordRequest) SetHumanInitialPasswordResponse

deprecated: use SetHumanPassword

POST: /users/{user_id}/password/_initialize

SetHumanPassword‚Äč

rpc SetHumanPassword(SetHumanPasswordRequest) SetHumanPasswordResponse

Set a new password for a user, on default the user has to change the password on the next login Set no_change_required to true if the user does not have to change the password on the next login

POST: /users/{user_id}/password

SendHumanResetPasswordNotification‚Äč

rpc SendHumanResetPasswordNotification(SendHumanResetPasswordNotificationRequest) SendHumanResetPasswordNotificationResponse

An email will be sent to the given address to reset the password of the user

POST: /users/{user_id}/password/_reset

ListHumanAuthFactors‚Äč

rpc ListHumanAuthFactors(ListHumanAuthFactorsRequest) ListHumanAuthFactorsResponse

Returns a list of all factors (second and multi) which are configured on the user

POST: /users/{user_id}/auth_factors/_search

RemoveHumanAuthFactorOTP‚Äč

rpc RemoveHumanAuthFactorOTP(RemoveHumanAuthFactorOTPRequest) RemoveHumanAuthFactorOTPResponse

The otp second factor will be removed from the user Because only one otp can be configured per user, the configured one will be removed

DELETE: /users/{user_id}/auth_factors/otp

RemoveHumanAuthFactorU2F‚Äč

rpc RemoveHumanAuthFactorU2F(RemoveHumanAuthFactorU2FRequest) RemoveHumanAuthFactorU2FResponse

The u2f (universial second factor) will be removed from the user

DELETE: /users/{user_id}/auth_factors/u2f/{token_id}

ListHumanPasswordless‚Äč

rpc ListHumanPasswordless(ListHumanPasswordlessRequest) ListHumanPasswordlessResponse

Returns all configured passwordless authenticators

POST: /users/{user_id}/passwordless/_search

AddPasswordlessRegistration‚Äč

rpc AddPasswordlessRegistration(AddPasswordlessRegistrationRequest) AddPasswordlessRegistrationResponse

Adds a new passwordless authenticator link to the user and returns it directly This link enables the user to register a new device if current passwordless devices are all platform authenticators e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone

POST: /users/{user_id}/passwordless/_link

SendPasswordlessRegistration‚Äč

rpc SendPasswordlessRegistration(SendPasswordlessRegistrationRequest) SendPasswordlessRegistrationResponse

Adds a new passwordless authenticator link to the user and sends it to the registered email address This link enables the user to register a new device if current passwordless devices are all platform authenticators e.g. User has already registered Windows Hello and wants to register FaceID on the iPhone

POST: /users/{user_id}/passwordless/_send_link

RemoveHumanPasswordless‚Äč

rpc RemoveHumanPasswordless(RemoveHumanPasswordlessRequest) RemoveHumanPasswordlessResponse

Removed a configured passwordless authenticator

DELETE: /users/{user_id}/passwordless/{token_id}

UpdateMachine‚Äč

rpc UpdateMachine(UpdateMachineRequest) UpdateMachineResponse

Changes a machine user

PUT: /users/{user_id}/machine

GetMachineKeyByIDs‚Äč

rpc GetMachineKeyByIDs(GetMachineKeyByIDsRequest) GetMachineKeyByIDsResponse

Returns a machine key of a (machine) user

GET: /users/{user_id}/keys/{key_id}

ListMachineKeys‚Äč

rpc ListMachineKeys(ListMachineKeysRequest) ListMachineKeysResponse

Returns all machine keys of a (machine) user which match the query Limit should always be set, there is a default limit set by the service

POST: /users/{user_id}/keys/_search

AddMachineKey‚Äč

rpc AddMachineKey(AddMachineKeyRequest) AddMachineKeyResponse

Generates a new machine key, details should be stored after return

POST: /users/{user_id}/keys

RemoveMachineKey‚Äč

rpc RemoveMachineKey(RemoveMachineKeyRequest) RemoveMachineKeyResponse

Removed a machine key

DELETE: /users/{user_id}/keys/{key_id}

ListHumanLinkedIDPs‚Äč

rpc ListHumanLinkedIDPs(ListHumanLinkedIDPsRequest) ListHumanLinkedIDPsResponse

Lists all identity providers (social logins) which a human has configured (e.g Google, Microsoft, AD, etc..) Limit should always be set, there is a default limit set by the service

POST: /users/{user_id}/idps/_search

RemoveHumanLinkedIDP‚Äč

rpc RemoveHumanLinkedIDP(RemoveHumanLinkedIDPRequest) RemoveHumanLinkedIDPResponse

Removed a configured identity provider (social login) of a human

DELETE: /users/{user_id}/idps/{idp_id}/{linked_user_id}

ListUserMemberships‚Äč

rpc ListUserMemberships(ListUserMembershipsRequest) ListUserMembershipsResponse

Show all the permissions a user has iin ZITADEL (ZITADEL Manager) Limit should always be set, there is a default limit set by the service

POST: /users/{user_id}/memberships/_search

GetMyOrg‚Äč

rpc GetMyOrg(GetMyOrgRequest) GetMyOrgResponse

Returns the org given in the header

GET: /orgs/me

GetOrgByDomainGlobal‚Äč

rpc GetOrgByDomainGlobal(GetOrgByDomainGlobalRequest) GetOrgByDomainGlobalResponse

Search a org over all organisations Domain must match exactly

GET: /global/orgs/_by_domain

ListOrgChanges‚Äč

rpc ListOrgChanges(ListOrgChangesRequest) ListOrgChangesResponse

Returns the history of my organisation (each event) Limit should always be set, there is a default limit set by the service

POST: /orgs/me/changes/_search

AddOrg‚Äč

rpc AddOrg(AddOrgRequest) AddOrgResponse

Creates a new organisation

POST: /orgs

UpdateOrg‚Äč

rpc UpdateOrg(UpdateOrgRequest) UpdateOrgResponse

Changes my organisation

PUT: /orgs/me

DeactivateOrg‚Äč

rpc DeactivateOrg(DeactivateOrgRequest) DeactivateOrgResponse

Sets the state of my organisation to deactivated Users of this organisation will not be able login

POST: /orgs/me/_deactivate

ReactivateOrg‚Äč

rpc ReactivateOrg(ReactivateOrgRequest) ReactivateOrgResponse

Sets the state of my organisation to active

POST: /orgs/me/_reactivate

ListOrgDomains‚Äč

rpc ListOrgDomains(ListOrgDomainsRequest) ListOrgDomainsResponse

Returns all registered domains of my organisation Limit should always be set, there is a default limit set by the service

POST: /orgs/me/domains/_search

AddOrgDomain‚Äč

rpc AddOrgDomain(AddOrgDomainRequest) AddOrgDomainResponse

Adds a new domain to my organisation

POST: /orgs/me/domains

RemoveOrgDomain‚Äč

rpc RemoveOrgDomain(RemoveOrgDomainRequest) RemoveOrgDomainResponse

Removed the domain from my organisation

DELETE: /orgs/me/domains/{domain}

GenerateOrgDomainValidation‚Äč

rpc GenerateOrgDomainValidation(GenerateOrgDomainValidationRequest) GenerateOrgDomainValidationResponse

Generates a new file to validate you domain

POST: /orgs/me/domains/{domain}/validation/_generate

ValidateOrgDomain‚Äč

rpc ValidateOrgDomain(ValidateOrgDomainRequest) ValidateOrgDomainResponse

Validates your domain with the choosen method Validated domains must be unique

POST: /orgs/me/domains/{domain}/validation/_validate

SetPrimaryOrgDomain‚Äč

rpc SetPrimaryOrgDomain(SetPrimaryOrgDomainRequest) SetPrimaryOrgDomainResponse

Sets the domain as primary Primary domain is shown as suffix on the preferred username on the users of the organisation

POST: /orgs/me/domains/{domain}/_set_primary

ListOrgMemberRoles‚Äč

rpc ListOrgMemberRoles(ListOrgMemberRolesRequest) ListOrgMemberRolesResponse

Returns all ZITADEL roles which are for organisation managers

POST: /orgs/members/roles/_search

ListOrgMembers‚Äč

rpc ListOrgMembers(ListOrgMembersRequest) ListOrgMembersResponse

Returns all ZITADEL managers of this organisation (Project and Project Grant managers not included) Limit should always be set, there is a default limit set by the service

POST: /orgs/me/members/_search

AddOrgMember‚Äč

rpc AddOrgMember(AddOrgMemberRequest) AddOrgMemberResponse

Adds a new organisation manager, which is allowed to administrate ZITADEL

POST: /orgs/me/members

UpdateOrgMember‚Äč

rpc UpdateOrgMember(UpdateOrgMemberRequest) UpdateOrgMemberResponse

Changes the organisation manager

PUT: /orgs/me/members/{user_id}

RemoveOrgMember‚Äč

rpc RemoveOrgMember(RemoveOrgMemberRequest) RemoveOrgMemberResponse

Removes an organisation manager

DELETE: /orgs/me/members/{user_id}

GetProjectByID‚Äč

rpc GetProjectByID(GetProjectByIDRequest) GetProjectByIDResponse

Returns a project from my organisation (no granted projects)

GET: /projects/{id}

GetGrantedProjectByID‚Äč

rpc GetGrantedProjectByID(GetGrantedProjectByIDRequest) GetGrantedProjectByIDResponse

returns a project my organisation got granted from another organisation

GET: /granted_projects/{project_id}/grants/{grant_id}

ListProjects‚Äč

rpc ListProjects(ListProjectsRequest) ListProjectsResponse

Returns all projects my organisation is the owner (no granted projects) Limit should always be set, there is a default limit set by the service

POST: /projects/_search

ListGrantedProjects‚Äč

rpc ListGrantedProjects(ListGrantedProjectsRequest) ListGrantedProjectsResponse

returns all projects my organisation got granted from another organisation Limit should always be set, there is a default limit set by the service

POST: /granted_projects/_search

ListGrantedProjectRoles‚Äč

rpc ListGrantedProjectRoles(ListGrantedProjectRolesRequest) ListGrantedProjectRolesResponse

returns all roles of a project grant Limit should always be set, there is a default limit set by the service

GET: /granted_projects/{project_id}/grants/{grant_id}/roles/_search

ListProjectChanges‚Äč

rpc ListProjectChanges(ListProjectChangesRequest) ListProjectChangesResponse

Returns the history of the project (each event) Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/changes/_search

AddProject‚Äč

rpc AddProject(AddProjectRequest) AddProjectResponse

Adds an new project to the organisation

POST: /projects

UpdateProject‚Äč

rpc UpdateProject(UpdateProjectRequest) UpdateProjectResponse

Changes a project

PUT: /projects/{id}

DeactivateProject‚Äč

rpc DeactivateProject(DeactivateProjectRequest) DeactivateProjectResponse

Sets the state of a project to deactivated Returns an error if project is already deactivated

POST: /projects/{id}/_deactivate

ReactivateProject‚Äč

rpc ReactivateProject(ReactivateProjectRequest) ReactivateProjectResponse

Sets the state of a project to active Returns an error if project is not deactivated

POST: /projects/{id}/_reactivate

RemoveProject‚Äč

rpc RemoveProject(RemoveProjectRequest) RemoveProjectResponse

Removes a project All project grants, applications and user grants for this project will be removed

DELETE: /projects/{id}

ListProjectRoles‚Äč

rpc ListProjectRoles(ListProjectRolesRequest) ListProjectRolesResponse

Returns all roles of a project matching the search query If no limit is requested, default limit will be set, if the limit is higher then the default an error will be returned

POST: /projects/{project_id}/roles/_search

AddProjectRole‚Äč

rpc AddProjectRole(AddProjectRoleRequest) AddProjectRoleResponse

Adds a role to a project, key must be unique in the project

POST: /projects/{project_id}/roles

BulkAddProjectRoles‚Äč

rpc BulkAddProjectRoles(BulkAddProjectRolesRequest) BulkAddProjectRolesResponse

add a list of project roles in one request

POST: /projects/{project_id}/roles/_bulk

UpdateProjectRole‚Äč

rpc UpdateProjectRole(UpdateProjectRoleRequest) UpdateProjectRoleResponse

Changes a project role, key is not editable If a key should change, remove the role and create a new

PUT: /projects/{project_id}/roles/{role_key}

RemoveProjectRole‚Äč

rpc RemoveProjectRole(RemoveProjectRoleRequest) RemoveProjectRoleResponse

Removes role from UserGrants, ProjectGrants and from Project

DELETE: /projects/{project_id}/roles/{role_key}

ListProjectMemberRoles‚Äč

rpc ListProjectMemberRoles(ListProjectMemberRolesRequest) ListProjectMemberRolesResponse

Returns all ZITADEL roles which are for project managers

POST: /projects/members/roles/_search

ListProjectMembers‚Äč

rpc ListProjectMembers(ListProjectMembersRequest) ListProjectMembersResponse

Returns all ZITADEL managers of a projects Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/members/_search

AddProjectMember‚Äč

rpc AddProjectMember(AddProjectMemberRequest) AddProjectMemberResponse

Adds a new project manager, which is allowed to administrate in ZITADEL

POST: /projects/{project_id}/members

UpdateProjectMember‚Äč

rpc UpdateProjectMember(UpdateProjectMemberRequest) UpdateProjectMemberResponse

Change project manager, which is allowed to administrate in ZITADEL

PUT: /projects/{project_id}/members/{user_id}

RemoveProjectMember‚Äč

rpc RemoveProjectMember(RemoveProjectMemberRequest) RemoveProjectMemberResponse

Remove project manager, which is allowed to administrate in ZITADEL

DELETE: /projects/{project_id}/members/{user_id}

GetAppByID‚Äč

rpc GetAppByID(GetAppByIDRequest) GetAppByIDResponse

Returns an application (oidc or api)

GET: /projects/{project_id}/apps/{app_id}

ListApps‚Äč

rpc ListApps(ListAppsRequest) ListAppsResponse

Returns all applications of a project matching the query Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/apps/_search

ListAppChanges‚Äč

rpc ListAppChanges(ListAppChangesRequest) ListAppChangesResponse

Returns the history of the application (each event) Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/apps/{app_id}/changes/_search

AddOIDCApp‚Äč

rpc AddOIDCApp(AddOIDCAppRequest) AddOIDCAppResponse

Adds a new oidc client Returns a client id Returns a new generated secret if needed (Depending on the configuration)

POST: /projects/{project_id}/apps/oidc

AddAPIApp‚Äč

rpc AddAPIApp(AddAPIAppRequest) AddAPIAppResponse

Adds a new api application Returns a client id Returns a new generated secret if needed (Depending on the configuration)

POST: /projects/{project_id}/apps/api

UpdateApp‚Äč

rpc UpdateApp(UpdateAppRequest) UpdateAppResponse

Changes application

PUT: /projects/{project_id}/apps/{app_id}

UpdateOIDCAppConfig‚Äč

rpc UpdateOIDCAppConfig(UpdateOIDCAppConfigRequest) UpdateOIDCAppConfigResponse

Changes the configuration of the oidc client

PUT: /projects/{project_id}/apps/{app_id}/oidc_config

UpdateAPIAppConfig‚Äč

rpc UpdateAPIAppConfig(UpdateAPIAppConfigRequest) UpdateAPIAppConfigResponse

Changes the configuration of the api application

PUT: /projects/{project_id}/apps/{app_id}/api_config

DeactivateApp‚Äč

rpc DeactivateApp(DeactivateAppRequest) DeactivateAppResponse

Set the state to deactivated Its not possible to request tokens for deactivated apps Returns an error if already deactivated

POST: /projects/{project_id}/apps/{app_id}/_deactivate

ReactivateApp‚Äč

rpc ReactivateApp(ReactivateAppRequest) ReactivateAppResponse

Set the state to active Returns an error if not deactivated

POST: /projects/{project_id}/apps/{app_id}/_reactivate

RemoveApp‚Äč

rpc RemoveApp(RemoveAppRequest) RemoveAppResponse

Removed the application

DELETE: /projects/{project_id}/apps/{app_id}

RegenerateOIDCClientSecret‚Äč

rpc RegenerateOIDCClientSecret(RegenerateOIDCClientSecretRequest) RegenerateOIDCClientSecretResponse

Generates a new client secret for the oidc client, make sure to save the response

POST: /projects/{project_id}/apps/{app_id}/oidc_config/_generate_client_secret

RegenerateAPIClientSecret‚Äč

rpc RegenerateAPIClientSecret(RegenerateAPIClientSecretRequest) RegenerateAPIClientSecretResponse

Generates a new client secret for the api application, make sure to save the response

POST: /projects/{project_id}/apps/{app_id}/api_config/_generate_client_secret

GetAppKey‚Äč

rpc GetAppKey(GetAppKeyRequest) GetAppKeyResponse

Returns an application key

GET: /projects/{project_id}/apps/{app_id}/keys/{key_id}

ListAppKeys‚Äč

rpc ListAppKeys(ListAppKeysRequest) ListAppKeysResponse

Returns all application keys matching the result Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/apps/{app_id}/keys/_search

AddAppKey‚Äč

rpc AddAppKey(AddAppKeyRequest) AddAppKeyResponse

Creates a new app key Will return key details in result, make sure to save it

POST: /projects/{project_id}/apps/{app_id}/keys

RemoveAppKey‚Äč

rpc RemoveAppKey(RemoveAppKeyRequest) RemoveAppKeyResponse

Removes an app key

DELETE: /projects/{project_id}/apps/{app_id}/keys/{key_id}

GetProjectGrantByID‚Äč

rpc GetProjectGrantByID(GetProjectGrantByIDRequest) GetProjectGrantByIDResponse

Returns a project grant (ProjectGrant = Grant another organisation for my project)

GET: /projects/{project_id}/grants/{grant_id}

ListProjectGrants‚Äč

rpc ListProjectGrants(ListProjectGrantsRequest) ListProjectGrantsResponse

Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/grants/_search

ListAllProjectGrants‚Äč

rpc ListAllProjectGrants(ListAllProjectGrantsRequest) ListAllProjectGrantsResponse

Returns all project grants matching the query, (ProjectGrant = Grant another organisation for my project) Limit should always be set, there is a default limit set by the service

POST: /projectgrants/_search

AddProjectGrant‚Äč

rpc AddProjectGrant(AddProjectGrantRequest) AddProjectGrantResponse

Add a new project grant (ProjectGrant = Grant another organisation for my project) Project Grant will be listed in granted project of the other organisation

POST: /projects/{project_id}/grants

UpdateProjectGrant‚Äč

rpc UpdateProjectGrant(UpdateProjectGrantRequest) UpdateProjectGrantResponse

Change project grant (ProjectGrant = Grant another organisation for my project) Project Grant will be listed in granted project of the other organisation

PUT: /projects/{project_id}/grants/{grant_id}

DeactivateProjectGrant‚Äč

rpc DeactivateProjectGrant(DeactivateProjectGrantRequest) DeactivateProjectGrantResponse

Set state of project grant to deactivated (ProjectGrant = Grant another organisation for my project) Returns error if project not active

POST: /projects/{project_id}/grants/{grant_id}/_deactivate

ReactivateProjectGrant‚Äč

rpc ReactivateProjectGrant(ReactivateProjectGrantRequest) ReactivateProjectGrantResponse

Set state of project grant to active (ProjectGrant = Grant another organisation for my project) Returns error if project not deactivated

POST: /projects/{project_id}/grants/{grant_id}/_reactivate

RemoveProjectGrant‚Äč

rpc RemoveProjectGrant(RemoveProjectGrantRequest) RemoveProjectGrantResponse

Removes project grant and all user grants for this project grant

DELETE: /projects/{project_id}/grants/{grant_id}

ListProjectGrantMemberRoles‚Äč

rpc ListProjectGrantMemberRoles(ListProjectGrantMemberRolesRequest) ListProjectGrantMemberRolesResponse

Returns all ZITADEL roles which are for project grant managers

POST: /projects/grants/members/roles/_search

ListProjectGrantMembers‚Äč

rpc ListProjectGrantMembers(ListProjectGrantMembersRequest) ListProjectGrantMembersResponse

Returns all ZITADEL managers of this project grant Limit should always be set, there is a default limit set by the service

POST: /projects/{project_id}/grants/{grant_id}/members/_search

AddProjectGrantMember‚Äč

rpc AddProjectGrantMember(AddProjectGrantMemberRequest) AddProjectGrantMemberResponse

Adds a new project grant manager, which is allowed to administrate in ZITADEL

POST: /projects/{project_id}/grants/{grant_id}/members

UpdateProjectGrantMember‚Äč

rpc UpdateProjectGrantMember(UpdateProjectGrantMemberRequest) UpdateProjectGrantMemberResponse

Changes project grant manager, which is allowed to administrate in ZITADEL

PUT: /projects/{project_id}/grants/{grant_id}/members/{user_id}

RemoveProjectGrantMember‚Äč

rpc RemoveProjectGrantMember(RemoveProjectGrantMemberRequest) RemoveProjectGrantMemberResponse

Removed project grant manager

DELETE: /projects/{project_id}/grants/{grant_id}/members/{user_id}

GetUserGrantByID‚Äč

rpc GetUserGrantByID(GetUserGrantByIDRequest) GetUserGrantByIDResponse

Returns a user grant (authorization of a user for a project)

GET: /users/{user_id}/grants/{grant_id}

ListUserGrants‚Äč

rpc ListUserGrants(ListUserGrantRequest) ListUserGrantResponse

Returns al user grant matching the query (authorizations of user for projects) Limit should always be set, there is a default limit set by the service

POST: /users/grants/_search

AddUserGrant‚Äč

rpc AddUserGrant(AddUserGrantRequest) AddUserGrantResponse

Creates a new user grant (authorization of a user for a project with specified roles)

POST: /users/{user_id}/grants

UpdateUserGrant‚Äč

rpc UpdateUserGrant(UpdateUserGrantRequest) UpdateUserGrantResponse

Changes a user grant (authorization of a user for a project with specified roles)

PUT: /users/{user_id}/grants/{grant_id}

DeactivateUserGrant‚Äč

rpc DeactivateUserGrant(DeactivateUserGrantRequest) DeactivateUserGrantResponse

Sets the state of a user grant to deactivated User will not be able to use the granted project anymore Returns an error if user grant is already deactivated

POST: /users/{user_id}/grants/{grant_id}/_deactivate

ReactivateUserGrant‚Äč

rpc ReactivateUserGrant(ReactivateUserGrantRequest) ReactivateUserGrantResponse

Sets the state of a user grant to active Returns an error if user grant is not deactivated

POST: /users/{user_id}/grants/{grant_id}/_reactivate

RemoveUserGrant‚Äč

rpc RemoveUserGrant(RemoveUserGrantRequest) RemoveUserGrantResponse

Removes a user grant

DELETE: /users/{user_id}/grants/{grant_id}

BulkRemoveUserGrant‚Äč

rpc BulkRemoveUserGrant(BulkRemoveUserGrantRequest) BulkRemoveUserGrantResponse

remove a list of user grants in one request

DELETE: /user_grants/_bulk

GetFeatures‚Äč

rpc GetFeatures(GetFeaturesRequest) GetFeaturesResponse

GET: /features

GetOrgIAMPolicy‚Äč

rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) GetOrgIAMPolicyResponse

Returns the org iam policy (this policy is managed by the iam administrator)

GET: /policies/orgiam

GetLoginPolicy‚Äč

rpc GetLoginPolicy(GetLoginPolicyRequest) GetLoginPolicyResponse

Returns the login policy of the organisation With this policy the login gui can be configured

GET: /policies/login

GetDefaultLoginPolicy‚Äč

rpc GetDefaultLoginPolicy(GetDefaultLoginPolicyRequest) GetDefaultLoginPolicyResponse

Returns the default login policy configured in the IAM

GET: /policies/default/login

AddCustomLoginPolicy‚Äč

rpc AddCustomLoginPolicy(AddCustomLoginPolicyRequest) AddCustomLoginPolicyResponse

Add a custom login policy for the organisation With this policy the login gui can be configured

POST: /policies/login

UpdateCustomLoginPolicy‚Äč

rpc UpdateCustomLoginPolicy(UpdateCustomLoginPolicyRequest) UpdateCustomLoginPolicyResponse

Change the custom login policy for the organisation With this policy the login gui can be configured

PUT: /policies/login

ResetLoginPolicyToDefault‚Äč

rpc ResetLoginPolicyToDefault(ResetLoginPolicyToDefaultRequest) ResetLoginPolicyToDefaultResponse

Removes the custom login policy of the organisation The default policy of the IAM will trigger after

DELETE: /policies/login

ListLoginPolicyIDPs‚Äč

rpc ListLoginPolicyIDPs(ListLoginPolicyIDPsRequest) ListLoginPolicyIDPsResponse

Lists all possible identity providers configured on the organisation Limit should always be set, there is a default limit set by the service

POST: /policies/login/idps/_search

AddIDPToLoginPolicy‚Äč

rpc AddIDPToLoginPolicy(AddIDPToLoginPolicyRequest) AddIDPToLoginPolicyResponse

Add a (preconfigured) identity provider to the custom login policy

POST: /policies/login/idps

RemoveIDPFromLoginPolicy‚Äč

rpc RemoveIDPFromLoginPolicy(RemoveIDPFromLoginPolicyRequest) RemoveIDPFromLoginPolicyResponse

Remove a identity provider from the custom login policy

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

ListLoginPolicySecondFactors‚Äč

rpc ListLoginPolicySecondFactors(ListLoginPolicySecondFactorsRequest) ListLoginPolicySecondFactorsResponse

Returns all configured second factors of the custom login policy

POST: /policies/login/second_factors/_search

AddSecondFactorToLoginPolicy‚Äč

rpc AddSecondFactorToLoginPolicy(AddSecondFactorToLoginPolicyRequest) AddSecondFactorToLoginPolicyResponse

Adds a new second factor to the custom login policy

POST: /policies/login/second_factors

RemoveSecondFactorFromLoginPolicy‚Äč

rpc RemoveSecondFactorFromLoginPolicy(RemoveSecondFactorFromLoginPolicyRequest) RemoveSecondFactorFromLoginPolicyResponse

Remove a second factor from the custom login policy

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

ListLoginPolicyMultiFactors‚Äč

rpc ListLoginPolicyMultiFactors(ListLoginPolicyMultiFactorsRequest) ListLoginPolicyMultiFactorsResponse

Returns all configured multi factors of the custom login policy

POST: /policies/login/auth_factors/_search

AddMultiFactorToLoginPolicy‚Äč

rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) AddMultiFactorToLoginPolicyResponse

Adds a new multi factor to the custom login policy

POST: /policies/login/multi_factors

RemoveMultiFactorFromLoginPolicy‚Äč

rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) RemoveMultiFactorFromLoginPolicyResponse

Remove a multi factor from the custom login policy

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

GetPasswordComplexityPolicy‚Äč

rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) GetPasswordComplexityPolicyResponse

Returns the password complexity policy of the organisation With this policy the password strength can be configured

GET: /policies/password/complexity

GetDefaultPasswordComplexityPolicy‚Äč

rpc GetDefaultPasswordComplexityPolicy(GetDefaultPasswordComplexityPolicyRequest) GetDefaultPasswordComplexityPolicyResponse

Returns the default password complexity policy of the IAM With this policy the password strength can be configured

GET: /policies/default/password/complexity

AddCustomPasswordComplexityPolicy‚Äč

rpc AddCustomPasswordComplexityPolicy(AddCustomPasswordComplexityPolicyRequest) AddCustomPasswordComplexityPolicyResponse

Add a custom password complexity policy for the organisation With this policy the password strength can be configured

POST: /policies/password/complexity

UpdateCustomPasswordComplexityPolicy‚Äč

rpc UpdateCustomPasswordComplexityPolicy(UpdateCustomPasswordComplexityPolicyRequest) UpdateCustomPasswordComplexityPolicyResponse

Update the custom password complexity policy for the organisation With this policy the password strength can be configured

PUT: /policies/password/complexity

ResetPasswordComplexityPolicyToDefault‚Äč

rpc ResetPasswordComplexityPolicyToDefault(ResetPasswordComplexityPolicyToDefaultRequest) ResetPasswordComplexityPolicyToDefaultResponse

Removes the custom password complexity policy of the organisation The default policy of the IAM will trigger after

DELETE: /policies/password/complexity

GetPasswordAgePolicy‚Äč

rpc GetPasswordAgePolicy(GetPasswordAgePolicyRequest) GetPasswordAgePolicyResponse

The password age policy is not used at the moment

GET: /policies/password/age

GetDefaultPasswordAgePolicy‚Äč

rpc GetDefaultPasswordAgePolicy(GetDefaultPasswordAgePolicyRequest) GetDefaultPasswordAgePolicyResponse

The password age policy is not used at the moment

GET: /policies/default/password/age

AddCustomPasswordAgePolicy‚Äč

rpc AddCustomPasswordAgePolicy(AddCustomPasswordAgePolicyRequest) AddCustomPasswordAgePolicyResponse

The password age policy is not used at the moment

POST: /policies/password/age

UpdateCustomPasswordAgePolicy‚Äč

rpc UpdateCustomPasswordAgePolicy(UpdateCustomPasswordAgePolicyRequest) UpdateCustomPasswordAgePolicyResponse

The password age policy is not used at the moment

PUT: /policies/password/age

ResetPasswordAgePolicyToDefault‚Äč

rpc ResetPasswordAgePolicyToDefault(ResetPasswordAgePolicyToDefaultRequest) ResetPasswordAgePolicyToDefaultResponse

The password age policy is not used at the moment

DELETE: /policies/password/age

GetLockoutPolicy‚Äč

rpc GetLockoutPolicy(GetLockoutPolicyRequest) GetLockoutPolicyResponse

GET: /policies/lockout

GetDefaultLockoutPolicy‚Äč

rpc GetDefaultLockoutPolicy(GetDefaultLockoutPolicyRequest) GetDefaultLockoutPolicyResponse

GET: /policies/default/lockout

AddCustomLockoutPolicy‚Äč

rpc AddCustomLockoutPolicy(AddCustomLockoutPolicyRequest) AddCustomLockoutPolicyResponse

POST: /policies/lockout

UpdateCustomLockoutPolicy‚Äč

rpc UpdateCustomLockoutPolicy(UpdateCustomLockoutPolicyRequest) UpdateCustomLockoutPolicyResponse

PUT: /policies/lockout

ResetLockoutPolicyToDefault‚Äč

rpc ResetLockoutPolicyToDefault(ResetLockoutPolicyToDefaultRequest) ResetLockoutPolicyToDefaultResponse

DELETE: /policies/lockout

GetPrivacyPolicy‚Äč

rpc GetPrivacyPolicy(GetPrivacyPolicyRequest) GetPrivacyPolicyResponse

Returns the privacy policy of the organisation With this policy privacy relevant things can be configured (e.g. tos link)

GET: /policies/privacy

GetDefaultPrivacyPolicy‚Äč

rpc GetDefaultPrivacyPolicy(GetDefaultPrivacyPolicyRequest) GetDefaultPrivacyPolicyResponse

Returns the default privacy policy of the IAM With this policy the privacy relevant things can be configured (e.g tos link)

GET: /policies/default/privacy

AddCustomPrivacyPolicy‚Äč

rpc AddCustomPrivacyPolicy(AddCustomPrivacyPolicyRequest) AddCustomPrivacyPolicyResponse

Add a custom privacy policy for the organisation With this policy privacy relevant things can be configured (e.g. tos link)

POST: /policies/privacy

UpdateCustomPrivacyPolicy‚Äč

rpc UpdateCustomPrivacyPolicy(UpdateCustomPrivacyPolicyRequest) UpdateCustomPrivacyPolicyResponse

Update the privacy complexity policy for the organisation With this policy privacy relevant things can be configured (e.g. tos link)

PUT: /policies/privacy

ResetPrivacyPolicyToDefault‚Äč

rpc ResetPrivacyPolicyToDefault(ResetPrivacyPolicyToDefaultRequest) ResetPrivacyPolicyToDefaultResponse

Removes the privacy policy of the organisation The default policy of the IAM will trigger after

DELETE: /policies/privacy

GetLabelPolicy‚Äč

rpc GetLabelPolicy(GetLabelPolicyRequest) GetLabelPolicyResponse

Returns the active label policy of the organisation With this policy the private labeling can be configured (colors, etc.)

GET: /policies/label

GetPreviewLabelPolicy‚Äč

rpc GetPreviewLabelPolicy(GetPreviewLabelPolicyRequest) GetPreviewLabelPolicyResponse

Returns the preview label policy of the organisation With this policy the private labeling can be configured (colors, etc.)

GET: /policies/label/_preview

GetDefaultLabelPolicy‚Äč

rpc GetDefaultLabelPolicy(GetDefaultLabelPolicyRequest) GetDefaultLabelPolicyResponse

Returns the default label policy of the IAM With this policy the private labeling can be configured (colors, etc.)

GET: /policies/default/label

AddCustomLabelPolicy‚Äč

rpc AddCustomLabelPolicy(AddCustomLabelPolicyRequest) AddCustomLabelPolicyResponse

Add a custom label policy for the organisation With this policy the private labeling can be configured (colors, etc.)

POST: /policies/label

UpdateCustomLabelPolicy‚Äč

rpc UpdateCustomLabelPolicy(UpdateCustomLabelPolicyRequest) UpdateCustomLabelPolicyResponse

Changes the custom label policy for the organisation With this policy the private labeling can be configured (colors, etc.)

PUT: /policies/label

ActivateCustomLabelPolicy‚Äč

rpc ActivateCustomLabelPolicy(ActivateCustomLabelPolicyRequest) ActivateCustomLabelPolicyResponse

Activates all changes of the label policy

POST: /policies/label/_activate

rpc RemoveCustomLabelPolicyLogo(RemoveCustomLabelPolicyLogoRequest) RemoveCustomLabelPolicyLogoResponse

Removes the logo of the label policy

DELETE: /policies/label/logo

RemoveCustomLabelPolicyLogoDark‚Äč

rpc RemoveCustomLabelPolicyLogoDark(RemoveCustomLabelPolicyLogoDarkRequest) RemoveCustomLabelPolicyLogoDarkResponse

Removes the logo dark of the label policy

DELETE: /policies/label/logo_dark

RemoveCustomLabelPolicyIcon‚Äč

rpc RemoveCustomLabelPolicyIcon(RemoveCustomLabelPolicyIconRequest) RemoveCustomLabelPolicyIconResponse

Removes the icon of the label policy

DELETE: /policies/label/icon

RemoveCustomLabelPolicyIconDark‚Äč

rpc RemoveCustomLabelPolicyIconDark(RemoveCustomLabelPolicyIconDarkRequest) RemoveCustomLabelPolicyIconDarkResponse

Removes the logo dark of the label policy

DELETE: /policies/label/icon_dark

RemoveCustomLabelPolicyFont‚Äč

rpc RemoveCustomLabelPolicyFont(RemoveCustomLabelPolicyFontRequest) RemoveCustomLabelPolicyFontResponse

Removes the font of the label policy

DELETE: /policies/label/font

ResetLabelPolicyToDefault‚Äč

rpc ResetLabelPolicyToDefault(ResetLabelPolicyToDefaultRequest) ResetLabelPolicyToDefaultResponse

Removes the custom label policy of the organisation The default policy of the IAM will trigger after

DELETE: /policies/label

GetCustomInitMessageText‚Äč

rpc GetCustomInitMessageText(GetCustomInitMessageTextRequest) GetCustomInitMessageTextResponse

Returns the custom text for initial message

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

GetDefaultInitMessageText‚Äč

rpc GetDefaultInitMessageText(GetDefaultInitMessageTextRequest) GetDefaultInitMessageTextResponse

Returns the default text for initial message

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

SetCustomInitMessageText‚Äč

rpc SetCustomInitMessageText(SetCustomInitMessageTextRequest) SetCustomInitMessageTextResponse

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

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

ResetCustomInitMessageTextToDefault‚Äč

rpc ResetCustomInitMessageTextToDefault(ResetCustomInitMessageTextToDefaultRequest) ResetCustomInitMessageTextToDefaultResponse

Removes the custom init message text of the organisation The default text of the IAM will trigger after

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

GetCustomPasswordResetMessageText‚Äč

rpc GetCustomPasswordResetMessageText(GetCustomPasswordResetMessageTextRequest) GetCustomPasswordResetMessageTextResponse

Returns the custom text for password reset message

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

GetDefaultPasswordResetMessageText‚Äč

rpc GetDefaultPasswordResetMessageText(GetDefaultPasswordResetMessageTextRequest) GetDefaultPasswordResetMessageTextResponse

Returns the default text for password reset message

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

SetCustomPasswordResetMessageText‚Äč

rpc SetCustomPasswordResetMessageText(SetCustomPasswordResetMessageTextRequest) SetCustomPasswordResetMessageTextResponse

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

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

ResetCustomPasswordResetMessageTextToDefault‚Äč

rpc ResetCustomPasswordResetMessageTextToDefault(ResetCustomPasswordResetMessageTextToDefaultRequest) ResetCustomPasswordResetMessageTextToDefaultResponse

Removes the custom password reset message text of the organisation The default text of the IAM will trigger after

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

GetCustomVerifyEmailMessageText‚Äč

rpc GetCustomVerifyEmailMessageText(GetCustomVerifyEmailMessageTextRequest) GetCustomVerifyEmailMessageTextResponse

Returns the custom text for verify email message

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

GetDefaultVerifyEmailMessageText‚Äč

rpc GetDefaultVerifyEmailMessageText(GetDefaultVerifyEmailMessageTextRequest) GetDefaultVerifyEmailMessageTextResponse

Returns the default text for verify email message

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

SetCustomVerifyEmailMessageText‚Äč

rpc SetCustomVerifyEmailMessageText(SetCustomVerifyEmailMessageTextRequest) SetCustomVerifyEmailMessageTextResponse

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

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

ResetCustomVerifyEmailMessageTextToDefault‚Äč

rpc ResetCustomVerifyEmailMessageTextToDefault(ResetCustomVerifyEmailMessageTextToDefaultRequest) ResetCustomVerifyEmailMessageTextToDefaultResponse

Removes the custom verify email message text of the organisation The default text of the IAM will trigger after

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

GetCustomVerifyPhoneMessageText‚Äč

rpc GetCustomVerifyPhoneMessageText(GetCustomVerifyPhoneMessageTextRequest) GetCustomVerifyPhoneMessageTextResponse

Returns the custom text for verify email message

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

GetDefaultVerifyPhoneMessageText‚Äč

rpc GetDefaultVerifyPhoneMessageText(GetDefaultVerifyPhoneMessageTextRequest) GetDefaultVerifyPhoneMessageTextResponse

Returns the custom text for verify email message

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

SetCustomVerifyPhoneMessageText‚Äč

rpc SetCustomVerifyPhoneMessageText(SetCustomVerifyPhoneMessageTextRequest) SetCustomVerifyPhoneMessageTextResponse

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

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

ResetCustomVerifyPhoneMessageTextToDefault‚Äč

rpc ResetCustomVerifyPhoneMessageTextToDefault(ResetCustomVerifyPhoneMessageTextToDefaultRequest) ResetCustomVerifyPhoneMessageTextToDefaultResponse

Removes the custom verify phone text of the organisation The default text of the IAM will trigger after

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

GetCustomDomainClaimedMessageText‚Äč

rpc GetCustomDomainClaimedMessageText(GetCustomDomainClaimedMessageTextRequest) GetCustomDomainClaimedMessageTextResponse

Returns the custom text for domain claimed message

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

GetDefaultDomainClaimedMessageText‚Äč

rpc GetDefaultDomainClaimedMessageText(GetDefaultDomainClaimedMessageTextRequest) GetDefaultDomainClaimedMessageTextResponse

Returns the custom text for domain claimed message

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

SetCustomDomainClaimedMessageCustomText‚Äč

rpc SetCustomDomainClaimedMessageCustomText(SetCustomDomainClaimedMessageTextRequest) SetCustomDomainClaimedMessageTextResponse

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

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

ResetCustomDomainClaimedMessageTextToDefault‚Äč

rpc ResetCustomDomainClaimedMessageTextToDefault(ResetCustomDomainClaimedMessageTextToDefaultRequest) ResetCustomDomainClaimedMessageTextToDefaultResponse

Removes the custom domain claimed message text of the organisation The default text of the IAM will trigger after

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

GetCustomPasswordlessRegistrationMessageText‚Äč

rpc GetCustomPasswordlessRegistrationMessageText(GetCustomPasswordlessRegistrationMessageTextRequest) GetCustomPasswordlessRegistrationMessageTextResponse

Returns the custom text for passwordless link message

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

GetDefaultPasswordlessRegistrationMessageText‚Äč

rpc GetDefaultPasswordlessRegistrationMessageText(GetDefaultPasswordlessRegistrationMessageTextRequest) GetDefaultPasswordlessRegistrationMessageTextResponse

Returns the custom text for passwordless link message

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

SetCustomPasswordlessRegistrationMessageCustomText‚Äč

rpc SetCustomPasswordlessRegistrationMessageCustomText(SetCustomPasswordlessRegistrationMessageTextRequest) SetCustomPasswordlessRegistrationMessageTextResponse

Sets the custom text for passwordless link message The Following Variables can be used: {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}

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

ResetCustomPasswordlessRegistrationMessageTextToDefault‚Äč

rpc ResetCustomPasswordlessRegistrationMessageTextToDefault(ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest) ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse

Removes the custom passwordless link message text of the organisation The default text of the IAM will trigger after

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

GetCustomLoginTexts‚Äč

rpc GetCustomLoginTexts(GetCustomLoginTextsRequest) GetCustomLoginTextsResponse

Returns the custom texts for login ui

GET: /text/login/{language}

GetDefaultLoginTexts‚Äč

rpc GetDefaultLoginTexts(GetDefaultLoginTextsRequest) GetDefaultLoginTextsResponse

Returns the custom texts for login ui

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

SetCustomLoginText‚Äč

rpc SetCustomLoginText(SetCustomLoginTextsRequest) SetCustomLoginTextsResponse

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

PUT: /text/login/{language}

ResetCustomLoginTextToDefault‚Äč

rpc ResetCustomLoginTextToDefault(ResetCustomLoginTextsToDefaultRequest) ResetCustomLoginTextsToDefaultResponse

Removes the custom login text of the organisation The default text of the IAM will trigger after

DELETE: /text/login/{language}

GetOrgIDPByID‚Äč

rpc GetOrgIDPByID(GetOrgIDPByIDRequest) GetOrgIDPByIDResponse

Returns a identity provider configuration of the organisation

GET: /idps/{id}

ListOrgIDPs‚Äč

rpc ListOrgIDPs(ListOrgIDPsRequest) ListOrgIDPsResponse

Returns all identity provider configuration in the organisation, which match the query Limit should always be set, there is a default limit set by the service

POST: /idps/_search

AddOrgOIDCIDP‚Äč

rpc AddOrgOIDCIDP(AddOrgOIDCIDPRequest) AddOrgOIDCIDPResponse

Add a new identity provider configuration in the organisation Provider must be OIDC compliant

POST: /idps/oidc

AddOrgJWTIDP‚Äč

rpc AddOrgJWTIDP(AddOrgJWTIDPRequest) AddOrgJWTIDPResponse

Add a new jwt identity provider configuration in the organisation

POST: /idps/jwt

DeactivateOrgIDP‚Äč

rpc DeactivateOrgIDP(DeactivateOrgIDPRequest) DeactivateOrgIDPResponse

Deactivate identity provider configuration Users will not be able to use this provider for login (e.g Google, Microsoft, AD, etc) Returns error if already deactivated

POST: /idps/{idp_id}/_deactivate

ReactivateOrgIDP‚Äč

rpc ReactivateOrgIDP(ReactivateOrgIDPRequest) ReactivateOrgIDPResponse

Activate identity provider configuration Returns error if not deactivated

POST: /idps/{idp_id}/_reactivate

RemoveOrgIDP‚Äč

rpc RemoveOrgIDP(RemoveOrgIDPRequest) RemoveOrgIDPResponse

Removes identity provider configuration Will remove all linked providers of this configuration on the users

DELETE: /idps/{idp_id}

UpdateOrgIDP‚Äč

rpc UpdateOrgIDP(UpdateOrgIDPRequest) UpdateOrgIDPResponse

Change identity provider configuration of the organisation

PUT: /idps/{idp_id}

UpdateOrgIDPOIDCConfig‚Äč

rpc UpdateOrgIDPOIDCConfig(UpdateOrgIDPOIDCConfigRequest) UpdateOrgIDPOIDCConfigResponse

Change OIDC identity provider configuration of the organisation

PUT: /idps/{idp_id}/oidc_config

UpdateOrgIDPJWTConfig‚Äč

rpc UpdateOrgIDPJWTConfig(UpdateOrgIDPJWTConfigRequest) UpdateOrgIDPJWTConfigResponse

Change JWT identity provider configuration of the organisation

PUT: /idps/{idp_id}/jwt_config

ListActions‚Äč

rpc ListActions(ListActionsRequest) ListActionsResponse

POST: /actions/_search

GetAction‚Äč

rpc GetAction(GetActionRequest) GetActionResponse

GET: /actions/{id}

CreateAction‚Äč

rpc CreateAction(CreateActionRequest) CreateActionResponse

POST: /actions

UpdateAction‚Äč

rpc UpdateAction(UpdateActionRequest) UpdateActionResponse

PUT: /actions/{id}

DeleteAction‚Äč

rpc DeleteAction(DeleteActionRequest) DeleteActionResponse

DELETE: /actions/{id}

GetFlow‚Äč

rpc GetFlow(GetFlowRequest) GetFlowResponse

GET: /flows/{type}

ClearFlow‚Äč

rpc ClearFlow(ClearFlowRequest) ClearFlowResponse

POST: /flows/{type}/_clear

SetTriggerActions‚Äč

rpc SetTriggerActions(SetTriggerActionsRequest) SetTriggerActionsResponse

POST: /flows/{flow_type}/trigger/{trigger_type}

Messages‚Äč

ActionQuery‚Äč

FieldTypeDescriptionValidation
oneof query.action_id_queryzitadel.action.v1.ActionIDQuery-
oneof query.action_name_queryzitadel.action.v1.ActionNameQuery-
oneof query.action_state_queryzitadel.action.v1.ActionStateQuery-

ActivateCustomLabelPolicyRequest‚Äč

This is an empty request

ActivateCustomLabelPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddAPIAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
auth_method_typezitadel.app.v1.APIAuthMethodType-enum.defined_only: true

AddAPIAppResponse‚Äč

FieldTypeDescriptionValidation
app_idstring-
detailszitadel.v1.ObjectDetails-
client_idstring-
client_secretstring-

AddAppKeyRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
typezitadel.authn.v1.KeyType-enum.defined_only: true
enum.not_in: [0]
expiration_dategoogle.protobuf.Timestamp-

AddAppKeyResponse‚Äč

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-
key_detailsbytes-

AddCustomLabelPolicyRequest‚Äč

FieldTypeDescriptionValidation
primary_colorstring-string.max_len: 50
hide_login_name_suffixboolhides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes
warn_colorstring-string.max_len: 50
background_colorstring-string.max_len: 50
font_colorstring-string.max_len: 50
primary_color_darkstring-string.max_len: 50
background_color_darkstring-string.max_len: 50
warn_color_darkstring-string.max_len: 50
font_color_darkstring-string.max_len: 50
disable_watermarkbool-

AddCustomLabelPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomLockoutPolicyRequest‚Äč

FieldTypeDescriptionValidation
max_password_attemptsuint32-

AddCustomLockoutPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomLoginPolicyRequest‚Äč

FieldTypeDescriptionValidation
allow_username_passwordbool-
allow_registerbool-
allow_external_idpbool-
force_mfabool-
passwordless_typezitadel.policy.v1.PasswordlessType-enum.defined_only: true
hide_password_resetbool-

AddCustomLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomPasswordAgePolicyRequest‚Äč

FieldTypeDescriptionValidation
max_age_daysuint32-
expire_warn_daysuint32-

AddCustomPasswordAgePolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomPasswordComplexityPolicyRequest‚Äč

FieldTypeDescriptionValidation
min_lengthuint64-
has_uppercasebool-
has_lowercasebool-
has_numberbool-
has_symbolbool-

AddCustomPasswordComplexityPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddCustomPrivacyPolicyRequest‚Äč

FieldTypeDescriptionValidation
tos_linkstring-
privacy_linkstring-

AddCustomPrivacyPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddHumanUserRequest‚Äč

FieldTypeDescriptionValidation
user_namestring-string.min_len: 1
string.max_len: 200
profileAddHumanUserRequest.Profile-message.required: true
emailAddHumanUserRequest.Email-message.required: true
phoneAddHumanUserRequest.Phone-
initial_passwordstring-

AddHumanUserRequest.Email‚Äč

FieldTypeDescriptionValidation
emailstringTODO: check if no value is allowedstring.email: true
is_email_verifiedbool-

AddHumanUserRequest.Phone‚Äč

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

AddHumanUserRequest.Profile‚Äč

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

AddHumanUserResponse‚Äč

FieldTypeDescriptionValidation
user_idstring-
detailszitadel.v1.ObjectDetails-

AddIDPToLoginPolicyRequest‚Äč

FieldTypeDescriptionValidation
idp_idstring-string.min_len: 1
string.max_len: 200
ownerTypezitadel.idp.v1.IDPOwnerType-enum.defined_only: true
enum.not_in: [0]

AddIDPToLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddMachineKeyRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
typezitadel.authn.v1.KeyType-enum.defined_only: true
enum.not_in: [0]
expiration_dategoogle.protobuf.Timestamp-

AddMachineKeyResponse‚Äč

FieldTypeDescriptionValidation
key_idstring-
key_detailsbytes-
detailszitadel.v1.ObjectDetails-

AddMachineUserRequest‚Äč

FieldTypeDescriptionValidation
user_namestring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
descriptionstring-string.max_len: 500

AddMachineUserResponse‚Äč

FieldTypeDescriptionValidation
user_idstring-
detailszitadel.v1.ObjectDetails-

AddMultiFactorToLoginPolicyRequest‚Äč

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

AddMultiFactorToLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddOIDCAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
redirect_urisrepeated string-
response_typesrepeated zitadel.app.v1.OIDCResponseType-
grant_typesrepeated zitadel.app.v1.OIDCGrantType-
app_typezitadel.app.v1.OIDCAppType-enum.defined_only: true
auth_method_typezitadel.app.v1.OIDCAuthMethodType-enum.defined_only: true
post_logout_redirect_urisrepeated string-
versionzitadel.app.v1.OIDCVersion-enum.defined_only: true
dev_modebool-
access_token_typezitadel.app.v1.OIDCTokenType-enum.defined_only: true
access_token_role_assertionbool-
id_token_role_assertionbool-
id_token_userinfo_assertionbool-
clock_skewgoogle.protobuf.Duration-duration.lte.seconds: 5
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
additional_originsrepeated string-

AddOIDCAppResponse‚Äč

FieldTypeDescriptionValidation
app_idstring-
detailszitadel.v1.ObjectDetails-
client_idstring-
client_secretstring-
none_compliantbool-
compliance_problemsrepeated zitadel.v1.LocalizedMessage-

AddOrgDomainRequest‚Äč

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

AddOrgDomainResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddOrgJWTIDPRequest‚Äč

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

AddOrgJWTIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idp_idstring-

AddOrgMemberRequest‚Äč

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

AddOrgMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddOrgOIDCIDPRequest‚Äč

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

AddOrgOIDCIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idp_idstring-

AddOrgRequest‚Äč

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

AddOrgResponse‚Äč

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-

AddPasswordlessRegistrationRequest‚Äč

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

AddPasswordlessRegistrationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
linkstring-
expirationgoogle.protobuf.Duration-

AddProjectGrantMemberRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200
user_idstring-string.min_len: 1
string.max_len: 200
rolesrepeated string-

AddProjectGrantMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddProjectGrantRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
granted_org_idstring-string.min_len: 1
string.max_len: 200
role_keysrepeated string-

AddProjectGrantResponse‚Äč

FieldTypeDescriptionValidation
grant_idstring-
detailszitadel.v1.ObjectDetails-

AddProjectMemberRequest‚Äč

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

AddProjectMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddProjectRequest‚Äč

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
project_role_assertionbool-
project_role_checkbool-
has_project_checkbool-
private_labeling_settingzitadel.project.v1.PrivateLabelingSetting-enum.defined_only: true

AddProjectResponse‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
detailszitadel.v1.ObjectDetails-

AddProjectRoleRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
role_keystring-string.min_len: 1
string.max_len: 200
display_namestring-string.min_len: 1
string.max_len: 200
groupstring-string.max_len: 200

AddProjectRoleResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddSecondFactorToLoginPolicyRequest‚Äč

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

AddSecondFactorToLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

AddUserGrantRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
project_idstring-string.min_len: 1
string.max_len: 200
project_grant_idstring-string.max_len: 200
role_keysrepeated string-

AddUserGrantResponse‚Äč

FieldTypeDescriptionValidation
user_grant_idstring-
detailszitadel.v1.ObjectDetails-

BulkAddProjectRolesRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
rolesrepeated BulkAddProjectRolesRequest.Role-

BulkAddProjectRolesRequest.Role‚Äč

FieldTypeDescriptionValidation
keystring-string.min_len: 1
string.max_len: 200
display_namestring-string.min_len: 1
string.max_len: 200
groupstring-string.max_len: 200

BulkAddProjectRolesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

BulkRemoveUserGrantRequest‚Äč

FieldTypeDescriptionValidation
grant_idrepeated string-

BulkRemoveUserGrantResponse‚Äč

BulkRemoveUserMetadataRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
keysrepeated string-repeated.items.string.min_len: 1
repeated.items.string.max_len: 200

BulkRemoveUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

BulkSetUserMetadataRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
metadatarepeated BulkSetUserMetadataRequest.Metadata-

BulkSetUserMetadataRequest.Metadata‚Äč

FieldTypeDescriptionValidation
keystring-string.min_len: 1
string.max_len: 200
valuebytes-bytes.min_len: 1
bytes.max_len: 500000

BulkSetUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ClearFlowRequest‚Äč

FieldTypeDescriptionValidation
typezitadel.action.v1.FlowType-

ClearFlowResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

CreateActionRequest‚Äč

FieldTypeDescriptionValidation
namestring-string.min_len: 1
string.max_len: 200
scriptstring-string.min_len: 1
string.max_len: 2000
timeoutgoogle.protobuf.Duration-duration.lte.seconds: 20
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
allowed_to_failbool-

CreateActionResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
idstring-

DeactivateActionRequest‚Äč

FieldTypeDescriptionValidation
idstring-

DeactivateActionResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

DeactivateAppResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateOrgIDPRequest‚Äč

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

DeactivateOrgIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateOrgRequest‚Äč

This is an empty request

DeactivateOrgResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateProjectGrantRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200

DeactivateProjectGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateProjectRequest‚Äč

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

DeactivateProjectResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateUserGrantRequest‚Äč

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

DeactivateUserGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeactivateUserRequest‚Äč

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

DeactivateUserResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

DeleteActionRequest‚Äč

FieldTypeDescriptionValidation
idstring-

DeleteActionResponse‚Äč

GenerateOrgDomainValidationRequest‚Äč

FieldTypeDescriptionValidation
domainstring-string.min_len: 1
string.max_len: 200
typezitadel.org.v1.DomainValidationType-enum.defined_only: true
enum.not_in: [0]

GenerateOrgDomainValidationResponse‚Äč

FieldTypeDescriptionValidation
tokenstring-
urlstring-

GetActionRequest‚Äč

FieldTypeDescriptionValidation
idstring-

GetActionResponse‚Äč

FieldTypeDescriptionValidation
actionzitadel.action.v1.Action-

GetAppByIDRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

GetAppByIDResponse‚Äč

FieldTypeDescriptionValidation
appzitadel.app.v1.App-

GetAppKeyRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
key_idstring-string.min_len: 1
string.max_len: 200

GetAppKeyResponse‚Äč

FieldTypeDescriptionValidation
keyzitadel.authn.v1.Key-

GetCustomDomainClaimedMessageTextRequest‚Äč

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

GetCustomDomainClaimedMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomInitMessageTextRequest‚Äč

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

GetCustomInitMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomLoginTextsRequest‚Äč

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

GetCustomLoginTextsResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.LoginCustomText-

GetCustomPasswordResetMessageTextRequest‚Äč

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

GetCustomPasswordResetMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomPasswordlessRegistrationMessageTextRequest‚Äč

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

GetCustomPasswordlessRegistrationMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomVerifyEmailMessageTextRequest‚Äč

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

GetCustomVerifyEmailMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetCustomVerifyPhoneMessageTextRequest‚Äč

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

GetCustomVerifyPhoneMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultDomainClaimedMessageTextRequest‚Äč

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

GetDefaultDomainClaimedMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultInitMessageTextRequest‚Äč

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

GetDefaultInitMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultLabelPolicyRequest‚Äč

This is an empty request

GetDefaultLabelPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LabelPolicy-

GetDefaultLockoutPolicyRequest‚Äč

This is an empty request

GetDefaultLockoutPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LockoutPolicy-

GetDefaultLoginPolicyRequest‚Äč

GetDefaultLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.LoginPolicy-

GetDefaultLoginTextsRequest‚Äč

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

GetDefaultLoginTextsResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.LoginCustomText-

GetDefaultPasswordAgePolicyRequest‚Äč

This is an empty request

GetDefaultPasswordAgePolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PasswordAgePolicy-

GetDefaultPasswordComplexityPolicyRequest‚Äč

This is an empty request

GetDefaultPasswordComplexityPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PasswordComplexityPolicy-

GetDefaultPasswordResetMessageTextRequest‚Äč

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

GetDefaultPasswordResetMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultPasswordlessRegistrationMessageTextRequest‚Äč

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

GetDefaultPasswordlessRegistrationMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultPrivacyPolicyRequest‚Äč

This is an empty request

GetDefaultPrivacyPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PrivacyPolicy-

GetDefaultVerifyEmailMessageTextRequest‚Äč

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

GetDefaultVerifyEmailMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetDefaultVerifyPhoneMessageTextRequest‚Äč

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

GetDefaultVerifyPhoneMessageTextResponse‚Äč

FieldTypeDescriptionValidation
custom_textzitadel.text.v1.MessageCustomText-

GetFeaturesRequest‚Äč

GetFeaturesResponse‚Äč

FieldTypeDescriptionValidation
featureszitadel.features.v1.Features-

GetFlowRequest‚Äč

FieldTypeDescriptionValidation
typezitadel.action.v1.FlowType-

GetFlowResponse‚Äč

FieldTypeDescriptionValidation
flowzitadel.action.v1.Flow-

GetGrantedProjectByIDRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200

GetGrantedProjectByIDResponse‚Äč

FieldTypeDescriptionValidation
granted_projectzitadel.project.v1.GrantedProject-

GetHumanEmailRequest‚Äč

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

GetHumanEmailResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
emailzitadel.user.v1.Email-

GetHumanPhoneRequest‚Äč

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

GetHumanPhoneResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
phonezitadel.user.v1.Phone-

GetHumanProfileRequest‚Äč

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

GetHumanProfileResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-
profilezitadel.user.v1.Profile-

GetIAMRequest‚Äč

This is an empty request

GetIAMResponse‚Äč

FieldTypeDescriptionValidation
global_org_idstring-
iam_project_idstring-

GetLabelPolicyRequest‚Äč

This is an empty request

GetLabelPolicyResponse‚Äč

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

GetLockoutPolicyRequest‚Äč

This is an empty request

GetLockoutPolicyResponse‚Äč

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

GetLoginPolicyRequest‚Äč

GetLoginPolicyResponse‚Äč

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

GetMachineKeyByIDsRequest‚Äč

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

GetMachineKeyByIDsResponse‚Äč

FieldTypeDescriptionValidation
keyzitadel.authn.v1.Key-

GetMyOrgRequest‚Äč

This is an empty request

GetMyOrgResponse‚Äč

FieldTypeDescriptionValidation
orgzitadel.org.v1.Org-

GetOIDCInformationRequest‚Äč

This is an empty request

GetOIDCInformationResponse‚Äč

FieldTypeDescriptionValidation
issuerstring-
discovery_endpointstring-

GetOrgByDomainGlobalRequest‚Äč

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

GetOrgByDomainGlobalResponse‚Äč

FieldTypeDescriptionValidation
orgzitadel.org.v1.Org-

GetOrgIAMPolicyRequest‚Äč

GetOrgIAMPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.OrgIAMPolicy-

GetOrgIDPByIDRequest‚Äč

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

GetOrgIDPByIDResponse‚Äč

FieldTypeDescriptionValidation
idpzitadel.idp.v1.IDP-

GetPasswordAgePolicyRequest‚Äč

This is an empty request

GetPasswordAgePolicyResponse‚Äč

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

GetPasswordComplexityPolicyRequest‚Äč

GetPasswordComplexityPolicyResponse‚Äč

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

GetPreviewLabelPolicyRequest‚Äč

This is an empty request

GetPreviewLabelPolicyResponse‚Äč

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

GetPrivacyPolicyRequest‚Äč

This is an empty request

GetPrivacyPolicyResponse‚Äč

FieldTypeDescriptionValidation
policyzitadel.policy.v1.PrivacyPolicy-

GetProjectByIDRequest‚Äč

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

GetProjectByIDResponse‚Äč

FieldTypeDescriptionValidation
projectzitadel.project.v1.Project-

GetProjectGrantByIDRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200

GetProjectGrantByIDResponse‚Äč

FieldTypeDescriptionValidation
project_grantzitadel.project.v1.GrantedProject-

GetSupportedLanguagesRequest‚Äč

This is an empty request

GetSupportedLanguagesResponse‚Äč

FieldTypeDescriptionValidation
languagesrepeated string-

GetUserByIDRequest‚Äč

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

GetUserByIDResponse‚Äč

FieldTypeDescriptionValidation
userzitadel.user.v1.User-

GetUserByLoginNameGlobalRequest‚Äč

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

GetUserByLoginNameGlobalResponse‚Äč

FieldTypeDescriptionValidation
userzitadel.user.v1.User-

GetUserGrantByIDRequest‚Äč

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

GetUserGrantByIDResponse‚Äč

FieldTypeDescriptionValidation
user_grantzitadel.user.v1.UserGrant-

GetUserMetadataRequest‚Äč

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

GetUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
metadatazitadel.metadata.v1.Metadata-

HealthzRequest‚Äč

This is an empty request

HealthzResponse‚Äč

This is an empty response

IDPQuery‚Äč

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

ImportHumanUserRequest‚Äč

FieldTypeDescriptionValidation
user_namestring-string.min_len: 1
string.max_len: 200
profileImportHumanUserRequest.Profile-message.required: true
emailImportHumanUserRequest.Email-message.required: true
phoneImportHumanUserRequest.Phone-
passwordstring-
password_change_requiredbool-
request_passwordless_registrationbool-

ImportHumanUserRequest.Email‚Äč

FieldTypeDescriptionValidation
emailstringTODO: check if no value is allowedstring.email: true
is_email_verifiedbool-

ImportHumanUserRequest.Phone‚Äč

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

ImportHumanUserRequest.Profile‚Äč

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

ImportHumanUserResponse‚Äč

FieldTypeDescriptionValidation
user_idstring-
detailszitadel.v1.ObjectDetails-
passwordless_registrationImportHumanUserResponse.PasswordlessRegistration-

ImportHumanUserResponse.PasswordlessRegistration‚Äč

FieldTypeDescriptionValidation
linkstring-
lifetimegoogle.protobuf.Durationdeprecated: use expiration instead
expirationgoogle.protobuf.Duration-

IsUserUniqueRequest‚Äč

FieldTypeDescriptionValidation
user_namestring-string.max_len: 200
emailstring-string.max_len: 200

IsUserUniqueResponse‚Äč

FieldTypeDescriptionValidation
is_uniquebool-

ListActionsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
sorting_columnzitadel.action.v1.ActionFieldNamethe field the result is sorted
queriesrepeated ActionQuerycriteria the client is looking for

ListActionsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
sorting_columnzitadel.action.v1.ActionFieldName-
resultrepeated zitadel.action.v1.Action-

ListAllProjectGrantsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.AllProjectGrantQuerycriterias the client is looking for

ListAllProjectGrantsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.GrantedProject-

ListAppChangesRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.change.v1.ChangeQuerylist limitations and ordering
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

ListAppChangesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.change.v1.Change-

ListAppKeysRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
app_idstring-string.min_len: 1
string.max_len: 200
project_idstring-string.min_len: 1
string.max_len: 200

ListAppKeysResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.authn.v1.Key-

ListAppsRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.app.v1.AppQuerycriterias the client is looking for

ListAppsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.app.v1.App-

ListGrantedProjectRolesRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.RoleQuerycriterias the client is looking for

ListGrantedProjectRolesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.Role-

ListGrantedProjectsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.ProjectQuerycriterias the client is looking for

ListGrantedProjectsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.GrantedProject-

ListHumanAuthFactorsRequest‚Äč

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

ListHumanAuthFactorsResponse‚Äč

FieldTypeDescriptionValidation
resultrepeated zitadel.user.v1.AuthFactor-

ListHumanLinkedIDPsRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering

ListHumanLinkedIDPsResponse‚Äč

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

ListHumanPasswordlessRequest‚Äč

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

ListHumanPasswordlessResponse‚Äč

FieldTypeDescriptionValidation
resultrepeated zitadel.user.v1.WebAuthNToken-

ListLoginPolicyIDPsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuery-

ListLoginPolicyIDPsResponse‚Äč

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

ListLoginPolicyMultiFactorsRequest‚Äč

ListLoginPolicyMultiFactorsResponse‚Äč

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

ListLoginPolicySecondFactorsRequest‚Äč

ListLoginPolicySecondFactorsResponse‚Äč

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

ListMachineKeysRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering

ListMachineKeysResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.authn.v1.Key-

ListOrgChangesRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.change.v1.ChangeQuerylist limitations and ordering

ListOrgChangesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.change.v1.Change-

ListOrgDomainsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.org.v1.DomainSearchQuerycriterias the client is looking for

ListOrgDomainsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.org.v1.Domain-

ListOrgIDPsRequest‚Äč

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

ListOrgIDPsResponse‚Äč

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

ListOrgMemberRolesRequest‚Äč

This is an empty request

ListOrgMemberRolesResponse‚Äč

FieldTypeDescriptionValidation
resultrepeated string-

ListOrgMembersRequest‚Äč

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

ListOrgMembersResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetailslist limitations and ordering
resultrepeated zitadel.member.v1.Membercriterias the client is looking for

ListProjectChangesRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.change.v1.ChangeQuerylist limitations and ordering
project_idstring-string.min_len: 1
string.max_len: 200

ListProjectChangesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.change.v1.Change-

ListProjectGrantMemberRolesRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuery-
resultrepeated string-

ListProjectGrantMemberRolesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated string-

ListProjectGrantMembersRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.member.v1.SearchQuerycriterias the client is looking for

ListProjectGrantMembersResponse‚Äč

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

ListProjectGrantsRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.ProjectGrantQuerycriterias the client is looking for

ListProjectGrantsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.GrantedProject-

ListProjectMemberRolesRequest‚Äč

This is an empty request

ListProjectMemberRolesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated string-

ListProjectMembersRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.member.v1.SearchQuerycriterias the client is looking for

ListProjectMembersResponse‚Äč

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

ListProjectRolesRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.RoleQuerycriterias the client is looking for

ListProjectRolesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.Role-

ListProjectsRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.project.v1.ProjectQuerycriterias the client is looking for

ListProjectsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.project.v1.Project-

ListUserChangesRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.change.v1.ChangeQuerylist limitations and ordering
user_idstring-string.min_len: 1
string.max_len: 200

ListUserChangesResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.change.v1.Change-

ListUserGrantRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
queriesrepeated zitadel.user.v1.UserGrantQuerycriterias the client is looking for

ListUserGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.user.v1.UserGrant-

ListUserMembershipsRequest‚Äč

FieldTypeDescriptionValidation
user_idstringlist limitations and orderingstring.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuerythe field the result is sorted
queriesrepeated zitadel.user.v1.MembershipQuerycriterias the client is looking for

ListUserMembershipsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.user.v1.Membership-

ListUserMetadataRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
queryzitadel.v1.ListQuery-
queriesrepeated zitadel.metadata.v1.MetadataQuery-

ListUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
resultrepeated zitadel.metadata.v1.Metadata-

ListUsersRequest‚Äč

FieldTypeDescriptionValidation
queryzitadel.v1.ListQuerylist limitations and ordering
sorting_columnzitadel.user.v1.UserFieldNamethe field the result is sorted
queriesrepeated zitadel.user.v1.SearchQuerycriterias the client is looking for

ListUsersResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ListDetails-
sorting_columnzitadel.user.v1.UserFieldName-
resultrepeated zitadel.user.v1.User-

LockUserRequest‚Äč

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

LockUserResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateActionRequest‚Äč

FieldTypeDescriptionValidation
idstring-

ReactivateActionResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

ReactivateAppResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateOrgIDPRequest‚Äč

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

ReactivateOrgIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateOrgRequest‚Äč

This is an empty request

ReactivateOrgResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateProjectGrantRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200

ReactivateProjectGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateProjectRequest‚Äč

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

ReactivateProjectResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateUserGrantRequest‚Äč

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

ReactivateUserGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ReactivateUserRequest‚Äč

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

ReactivateUserResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RegenerateAPIClientSecretRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

RegenerateAPIClientSecretResponse‚Äč

FieldTypeDescriptionValidation
client_secretstring-
detailszitadel.v1.ObjectDetails-

RegenerateOIDCClientSecretRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

RegenerateOIDCClientSecretResponse‚Äč

FieldTypeDescriptionValidation
client_secretstring-
detailszitadel.v1.ObjectDetails-

RemoveAppKeyRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
key_idstring-string.min_len: 1
string.max_len: 200

RemoveAppKeyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200

RemoveAppResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveCustomLabelPolicyFontRequest‚Äč

This is an empty request

RemoveCustomLabelPolicyFontResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveCustomLabelPolicyIconDarkRequest‚Äč

This is an empty request

RemoveCustomLabelPolicyIconDarkResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveCustomLabelPolicyIconRequest‚Äč

This is an empty request

RemoveCustomLabelPolicyIconResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveCustomLabelPolicyLogoDarkRequest‚Äč

This is an empty request

RemoveCustomLabelPolicyLogoDarkResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveCustomLabelPolicyLogoRequest‚Äč

This is an empty request

RemoveCustomLabelPolicyLogoResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanAuthFactorOTPRequest‚Äč

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

RemoveHumanAuthFactorOTPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanAuthFactorU2FRequest‚Äč

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

RemoveHumanAuthFactorU2FResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanAvatarRequest‚Äč

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

RemoveHumanAvatarResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanLinkedIDPRequest‚Äč

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

RemoveHumanLinkedIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanPasswordlessRequest‚Äč

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

RemoveHumanPasswordlessResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveHumanPhoneRequest‚Äč

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

RemoveHumanPhoneResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveIDPFromLoginPolicyRequest‚Äč

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

RemoveIDPFromLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveMachineKeyRequest‚Äč

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

RemoveMachineKeyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveMultiFactorFromLoginPolicyRequest‚Äč

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

RemoveMultiFactorFromLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveOrgDomainRequest‚Äč

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

RemoveOrgDomainResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveOrgIDPRequest‚Äč

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

RemoveOrgIDPResponse‚Äč

This is an empty response

RemoveOrgMemberRequest‚Äč

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

RemoveOrgMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveProjectGrantMemberRequest‚Äč

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

RemoveProjectGrantMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveProjectGrantRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200

RemoveProjectGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveProjectMemberRequest‚Äč

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

RemoveProjectMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveProjectRequest‚Äč

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

RemoveProjectResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveProjectRoleRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
role_keystring-string.min_len: 1
string.max_len: 200

RemoveProjectRoleResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveSecondFactorFromLoginPolicyRequest‚Äč

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

RemoveSecondFactorFromLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveUserGrantRequest‚Äč

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

RemoveUserGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveUserMetadataRequest‚Äč

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

RemoveUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

RemoveUserRequest‚Äč

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

RemoveUserResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResendHumanEmailVerificationRequest‚Äč

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

ResendHumanEmailVerificationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResendHumanInitializationRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
emailstring-string.email: true
string.ignore_empty: true

ResendHumanInitializationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResendHumanPhoneVerificationRequest‚Äč

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

ResendHumanPhoneVerificationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomDomainClaimedMessageTextToDefaultRequest‚Äč

This is an empty request

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

ResetCustomDomainClaimedMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomInitMessageTextToDefaultRequest‚Äč

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

ResetCustomInitMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomLoginTextsToDefaultRequest‚Äč

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

ResetCustomLoginTextsToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomPasswordResetMessageTextToDefaultRequest‚Äč

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

ResetCustomPasswordResetMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest‚Äč

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

ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomVerifyEmailMessageTextToDefaultRequest‚Äč

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

ResetCustomVerifyEmailMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetCustomVerifyPhoneMessageTextToDefaultRequest‚Äč

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

ResetCustomVerifyPhoneMessageTextToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetLabelPolicyToDefaultRequest‚Äč

This is an empty request

ResetLabelPolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetLockoutPolicyToDefaultRequest‚Äč

This is an empty request

ResetLockoutPolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetLoginPolicyToDefaultRequest‚Äč

ResetLoginPolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetPasswordAgePolicyToDefaultRequest‚Äč

This is an empty request

ResetPasswordAgePolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetPasswordComplexityPolicyToDefaultRequest‚Äč

This is an empty request

ResetPasswordComplexityPolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ResetPrivacyPolicyToDefaultRequest‚Äč

This is an empty request

ResetPrivacyPolicyToDefaultResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SendHumanResetPasswordNotificationRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
typeSendHumanResetPasswordNotificationRequest.Type-enum.defined_only: true

SendHumanResetPasswordNotificationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SendPasswordlessRegistrationRequest‚Äč

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

SendPasswordlessRegistrationResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomDomainClaimedMessageTextRequest‚Äč

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

SetCustomDomainClaimedMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomInitMessageTextRequest‚Äč

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

SetCustomInitMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomLoginTextsRequest‚Äč

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

SetCustomLoginTextsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomPasswordResetMessageTextRequest‚Äč

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

SetCustomPasswordResetMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomPasswordlessRegistrationMessageTextRequest‚Äč

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

SetCustomPasswordlessRegistrationMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomVerifyEmailMessageTextRequest‚Äč

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

SetCustomVerifyEmailMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetCustomVerifyPhoneMessageTextRequest‚Äč

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

SetCustomVerifyPhoneMessageTextResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetHumanInitialPasswordRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
passwordstring-string.min_len: 1
string.max_len: 72

SetHumanInitialPasswordResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetHumanPasswordRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
passwordstring-string.min_len: 1
string.max_len: 72
no_change_requiredbool-

SetHumanPasswordResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetPrimaryOrgDomainRequest‚Äč

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

SetPrimaryOrgDomainResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetTriggerActionsRequest‚Äč

FieldTypeDescriptionValidation
flow_typezitadel.action.v1.FlowType-
trigger_typezitadel.action.v1.TriggerType-
action_idsrepeated string-

SetTriggerActionsResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

SetUserMetadataRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
keystring-string.min_len: 1
string.max_len: 200
valuebytes-bytes.min_len: 1
bytes.max_len: 500000

SetUserMetadataResponse‚Äč

FieldTypeDescriptionValidation
idstring-
detailszitadel.v1.ObjectDetails-

UnlockUserRequest‚Äč

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

UnlockUserResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateAPIAppConfigRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
auth_method_typezitadel.app.v1.APIAuthMethodType-enum.defined_only: true

UpdateAPIAppConfigResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateActionRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
scriptstring-string.min_len: 1
string.max_len: 2000
timeoutgoogle.protobuf.Duration-duration.lte.seconds: 20
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
allowed_to_failbool-

UpdateActionResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateAppRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200

UpdateAppResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomLabelPolicyRequest‚Äč

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

UpdateCustomLabelPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomLockoutPolicyRequest‚Äč

FieldTypeDescriptionValidation
max_password_attemptsuint32-

UpdateCustomLockoutPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomLoginPolicyRequest‚Äč

FieldTypeDescriptionValidation
allow_username_passwordbool-
allow_registerbool-
allow_external_idpbool-
force_mfabool-
passwordless_typezitadel.policy.v1.PasswordlessType-enum.defined_only: true
hide_password_resetbool-

UpdateCustomLoginPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomPasswordAgePolicyRequest‚Äč

FieldTypeDescriptionValidation
max_age_daysuint32-
expire_warn_daysuint32-

UpdateCustomPasswordAgePolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomPasswordComplexityPolicyRequest‚Äč

FieldTypeDescriptionValidation
min_lengthuint64-
has_uppercasebool-
has_lowercasebool-
has_numberbool-
has_symbolbool-

UpdateCustomPasswordComplexityPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateCustomPrivacyPolicyRequest‚Äč

FieldTypeDescriptionValidation
tos_linkstring-
privacy_linkstring-

UpdateCustomPrivacyPolicyResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateHumanEmailRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
emailstring-string.email: true
is_email_verifiedbool-

UpdateHumanEmailResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateHumanPhoneRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
phonestring-string.min_len: 1
string.max_len: 50
string.prefix: +
is_phone_verifiedbool-

UpdateHumanPhoneResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateHumanProfileRequest‚Äč

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

UpdateHumanProfileResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateMachineRequest‚Äč

FieldTypeDescriptionValidation
user_idstring-string.min_len: 1
string.max_len: 200
descriptionstring-string.max_len: 500
namestring-string.min_len: 1
string.max_len: 200

UpdateMachineResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOIDCAppConfigRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
app_idstring-string.min_len: 1
string.max_len: 200
redirect_urisrepeated string-
response_typesrepeated zitadel.app.v1.OIDCResponseType-
grant_typesrepeated zitadel.app.v1.OIDCGrantType-
app_typezitadel.app.v1.OIDCAppType-enum.defined_only: true
auth_method_typezitadel.app.v1.OIDCAuthMethodType-enum.defined_only: true
post_logout_redirect_urisrepeated string-
dev_modebool-
access_token_typezitadel.app.v1.OIDCTokenType-enum.defined_only: true
access_token_role_assertionbool-
id_token_role_assertionbool-
id_token_userinfo_assertionbool-
clock_skewgoogle.protobuf.Duration-duration.lte.seconds: 5
duration.lte.nanos: 0
duration.gte.seconds: 0
duration.gte.nanos: 0
additional_originsrepeated string-

UpdateOIDCAppConfigResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgIDPJWTConfigRequest‚Äč

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

UpdateOrgIDPJWTConfigResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgIDPOIDCConfigRequest‚Äč

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

UpdateOrgIDPOIDCConfigResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgIDPRequest‚Äč

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

UpdateOrgIDPResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgMemberRequest‚Äč

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

UpdateOrgMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateOrgRequest‚Äč

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

UpdateOrgResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateProjectGrantMemberRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200
user_idstring-string.min_len: 1
string.max_len: 200
rolesrepeated string-

UpdateProjectGrantMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateProjectGrantRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
grant_idstring-string.min_len: 1
string.max_len: 200
role_keysrepeated string-

UpdateProjectGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateProjectMemberRequest‚Äč

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

UpdateProjectMemberResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateProjectRequest‚Äč

FieldTypeDescriptionValidation
idstring-string.min_len: 1
string.max_len: 200
namestring-string.min_len: 1
string.max_len: 200
project_role_assertionbool-
project_role_checkbool-
has_project_checkbool-
private_labeling_settingzitadel.project.v1.PrivateLabelingSetting-enum.defined_only: true

UpdateProjectResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateProjectRoleRequest‚Äč

FieldTypeDescriptionValidation
project_idstring-string.min_len: 1
string.max_len: 200
role_keystring-string.min_len: 1
string.max_len: 200
display_namestring-string.min_len: 1
string.max_len: 200
groupstring-string.max_len: 200

UpdateProjectRoleResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateUserGrantRequest‚Äč

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

UpdateUserGrantResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

UpdateUserNameRequest‚Äč

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

UpdateUserNameResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-

ValidateOrgDomainRequest‚Äč

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

ValidateOrgDomainResponse‚Äč

FieldTypeDescriptionValidation
detailszitadel.v1.ObjectDetails-