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

GET: /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

RemoveCustomLabelPolicyLogo#

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-