* feat: command side privacy policy * feat: add privacy policy to api * feat: add privacy policy query side * fix: add privacy policy to mgmt api * fix: add privacy policy to auth and base data * feat: use privacyPolicy in login gui * feat: use privacyPolicy in login gui * feat: test org fatures * feat: typos * feat: tos in register
142 KiB
title
| title |
|---|
| zitadel/management.proto |
This document reflects the state from API 1.0 (available from 20.04.2021)
ManagementService
Healthz
rpc Healthz(HealthzRequest) HealthzResponse
GetOIDCInformation
rpc GetOIDCInformation(GetOIDCInformationRequest) GetOIDCInformationResponse
GetIAM
rpc GetIAM(GetIAMRequest) GetIAMResponse
Returns some needed settings of the IAM (Global Organisation ID, Zitadel Project ID)
GetUserByID
rpc GetUserByID(GetUserByIDRequest) GetUserByIDResponse
Returns the requested full blown user (human or machine)
GetUserByLoginNameGlobal
rpc GetUserByLoginNameGlobal(GetUserByLoginNameGlobalRequest) GetUserByLoginNameGlobalResponse
Searches a user over all organisations the login name has to match exactly
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
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
IsUserUnique
rpc IsUserUnique(IsUserUniqueRequest) IsUserUniqueResponse
Returns if a user with the searched email or username 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
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
AddMachineUser
rpc AddMachineUser(AddMachineUserRequest) AddMachineUserResponse
Create a user of the type 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
ReactivateUser
rpc ReactivateUser(ReactivateUserRequest) ReactivateUserResponse
Changes the user state to active returns an error if user state is not deactivated
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
UnlockUser
rpc UnlockUser(UnlockUserRequest) UnlockUserResponse
Changes the user state to active returns an error if user state is not locked
RemoveUser
rpc RemoveUser(RemoveUserRequest) RemoveUserResponse
Changes the user state to deleted
UpdateUserName
rpc UpdateUserName(UpdateUserNameRequest) UpdateUserNameResponse
Changes the username
GetHumanProfile
rpc GetHumanProfile(GetHumanProfileRequest) GetHumanProfileResponse
Returns the profile of the human
UpdateHumanProfile
rpc UpdateHumanProfile(UpdateHumanProfileRequest) UpdateHumanProfileResponse
Changes the profile of the human
GetHumanEmail
rpc GetHumanEmail(GetHumanEmailRequest) GetHumanEmailResponse
GetHumanEmail returns the email and verified state of the human
UpdateHumanEmail
rpc UpdateHumanEmail(UpdateHumanEmailRequest) UpdateHumanEmailResponse
Changes the email of the human If state is not verified, the user will get a verification 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
ResendHumanEmailVerification
rpc ResendHumanEmailVerification(ResendHumanEmailVerificationRequest) ResendHumanEmailVerificationResponse
Resends an email to the given email address to finish the email verification process of the user
GetHumanPhone
rpc GetHumanPhone(GetHumanPhoneRequest) GetHumanPhoneResponse
Returns the phone and verified state of the human 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
RemoveHumanPhone
rpc RemoveHumanPhone(RemoveHumanPhoneRequest) RemoveHumanPhoneResponse
Removes the phone number of the human
ResendHumanPhoneVerification
rpc ResendHumanPhoneVerification(ResendHumanPhoneVerificationRequest) ResendHumanPhoneVerificationResponse
An sms will be sent to the given phone number to finish the phone verification process of the user
RemoveMyAvatar
rpc RemoveMyAvatar(RemoveHumanAvatarRequest) RemoveHumanAvatarResponse
Removes the avatar number of the human
SetHumanInitialPassword
rpc SetHumanInitialPassword(SetHumanInitialPasswordRequest) SetHumanInitialPasswordResponse
deprecated: use SetHumanPassword
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
SendHumanResetPasswordNotification
rpc SendHumanResetPasswordNotification(SendHumanResetPasswordNotificationRequest) SendHumanResetPasswordNotificationResponse
An email will be sent to the given address to reset the password of the user
ListHumanAuthFactors
rpc ListHumanAuthFactors(ListHumanAuthFactorsRequest) ListHumanAuthFactorsResponse
Returns a list of all factors (second and multi) which are configured on the user
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
RemoveHumanAuthFactorU2F
rpc RemoveHumanAuthFactorU2F(RemoveHumanAuthFactorU2FRequest) RemoveHumanAuthFactorU2FResponse
The u2f (universial second factor) will be removed from the user
ListHumanPasswordless
rpc ListHumanPasswordless(ListHumanPasswordlessRequest) ListHumanPasswordlessResponse
Returns all configured passwordless authentications
RemoveHumanPasswordless
rpc RemoveHumanPasswordless(RemoveHumanPasswordlessRequest) RemoveHumanPasswordlessResponse
Removed a configured passwordless authentication
UpdateMachine
rpc UpdateMachine(UpdateMachineRequest) UpdateMachineResponse
Changes a machine user
GetMachineKeyByIDs
rpc GetMachineKeyByIDs(GetMachineKeyByIDsRequest) GetMachineKeyByIDsResponse
Returns a machine key of a (machine) user
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
AddMachineKey
rpc AddMachineKey(AddMachineKeyRequest) AddMachineKeyResponse
Generates a new machine key, details should be stored after return
RemoveMachineKey
rpc RemoveMachineKey(RemoveMachineKeyRequest) RemoveMachineKeyResponse
Removed a machine key
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
RemoveHumanLinkedIDP
rpc RemoveHumanLinkedIDP(RemoveHumanLinkedIDPRequest) RemoveHumanLinkedIDPResponse
Removed a configured identity provider (social login) of a human
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
GetMyOrg
rpc GetMyOrg(GetMyOrgRequest) GetMyOrgResponse
Returns the org given in the header
GetOrgByDomainGlobal
rpc GetOrgByDomainGlobal(GetOrgByDomainGlobalRequest) GetOrgByDomainGlobalResponse
Search a org over all organisations Domain must match exactly
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
AddOrg
rpc AddOrg(AddOrgRequest) AddOrgResponse
Creates a new organisation
UpdateOrg
rpc UpdateOrg(UpdateOrgRequest) UpdateOrgResponse
Changes my organisation
DeactivateOrg
rpc DeactivateOrg(DeactivateOrgRequest) DeactivateOrgResponse
Sets the state of my organisation to deactivated Users of this organisation will not be able login
ReactivateOrg
rpc ReactivateOrg(ReactivateOrgRequest) ReactivateOrgResponse
Sets the state of my organisation to active
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
AddOrgDomain
rpc AddOrgDomain(AddOrgDomainRequest) AddOrgDomainResponse
Adds a new domain to my organisation
RemoveOrgDomain
rpc RemoveOrgDomain(RemoveOrgDomainRequest) RemoveOrgDomainResponse
Removed the domain from my organisation
GenerateOrgDomainValidation
rpc GenerateOrgDomainValidation(GenerateOrgDomainValidationRequest) GenerateOrgDomainValidationResponse
Generates a new file to validate you domain
ValidateOrgDomain
rpc ValidateOrgDomain(ValidateOrgDomainRequest) ValidateOrgDomainResponse
Validates your domain with the choosen method Validated domains must be unique
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
ListOrgMemberRoles
rpc ListOrgMemberRoles(ListOrgMemberRolesRequest) ListOrgMemberRolesResponse
Returns all ZITADEL roles which are for organisation managers
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
AddOrgMember
rpc AddOrgMember(AddOrgMemberRequest) AddOrgMemberResponse
Adds a new organisation manager, which is allowed to administrate ZITADEL
UpdateOrgMember
rpc UpdateOrgMember(UpdateOrgMemberRequest) UpdateOrgMemberResponse
Changes the organisation manager
RemoveOrgMember
rpc RemoveOrgMember(RemoveOrgMemberRequest) RemoveOrgMemberResponse
Removes an organisation manager
GetProjectByID
rpc GetProjectByID(GetProjectByIDRequest) GetProjectByIDResponse
Returns a project from my organisation (no granted projects)
GetGrantedProjectByID
rpc GetGrantedProjectByID(GetGrantedProjectByIDRequest) GetGrantedProjectByIDResponse
returns a project my organisation got granted from another organisation
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
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
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
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
AddProject
rpc AddProject(AddProjectRequest) AddProjectResponse
Adds an new project to the organisation
UpdateProject
rpc UpdateProject(UpdateProjectRequest) UpdateProjectResponse
Changes a project
DeactivateProject
rpc DeactivateProject(DeactivateProjectRequest) DeactivateProjectResponse
Sets the state of a project to deactivated Returns an error if project is already deactivated
ReactivateProject
rpc ReactivateProject(ReactivateProjectRequest) ReactivateProjectResponse
Sets the state of a project to active Returns an error if project is not deactivated
RemoveProject
rpc RemoveProject(RemoveProjectRequest) RemoveProjectResponse
Removes a project All project grants, applications and user grants for this project will be removed
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
AddProjectRole
rpc AddProjectRole(AddProjectRoleRequest) AddProjectRoleResponse
Adds a role to a project, key must be unique in the project
BulkAddProjectRoles
rpc BulkAddProjectRoles(BulkAddProjectRolesRequest) BulkAddProjectRolesResponse
add a list of project roles in one request
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
RemoveProjectRole
rpc RemoveProjectRole(RemoveProjectRoleRequest) RemoveProjectRoleResponse
Removes role from UserGrants, ProjectGrants and from Project
ListProjectMemberRoles
rpc ListProjectMemberRoles(ListProjectMemberRolesRequest) ListProjectMemberRolesResponse
Returns all ZITADEL roles which are for project managers
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
AddProjectMember
rpc AddProjectMember(AddProjectMemberRequest) AddProjectMemberResponse
Adds a new project manager, which is allowed to administrate in ZITADEL
UpdateProjectMember
rpc UpdateProjectMember(UpdateProjectMemberRequest) UpdateProjectMemberResponse
Change project manager, which is allowed to administrate in ZITADEL
RemoveProjectMember
rpc RemoveProjectMember(RemoveProjectMemberRequest) RemoveProjectMemberResponse
Remove project manager, which is allowed to administrate in ZITADEL
GetAppByID
rpc GetAppByID(GetAppByIDRequest) GetAppByIDResponse
Returns an application (oidc or api)
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
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
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)
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)
UpdateApp
rpc UpdateApp(UpdateAppRequest) UpdateAppResponse
Changes application
UpdateOIDCAppConfig
rpc UpdateOIDCAppConfig(UpdateOIDCAppConfigRequest) UpdateOIDCAppConfigResponse
Changes the configuration of the oidc client
UpdateAPIAppConfig
rpc UpdateAPIAppConfig(UpdateAPIAppConfigRequest) UpdateAPIAppConfigResponse
Changes the configuration of the api application
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
ReactivateApp
rpc ReactivateApp(ReactivateAppRequest) ReactivateAppResponse
Set the state to active Returns an error if not deactivated
RemoveApp
rpc RemoveApp(RemoveAppRequest) RemoveAppResponse
Removed the application
RegenerateOIDCClientSecret
rpc RegenerateOIDCClientSecret(RegenerateOIDCClientSecretRequest) RegenerateOIDCClientSecretResponse
Generates a new client secret for the oidc client, make sure to save the response
RegenerateAPIClientSecret
rpc RegenerateAPIClientSecret(RegenerateAPIClientSecretRequest) RegenerateAPIClientSecretResponse
Generates a new client secret for the api application, make sure to save the response
GetAppKey
rpc GetAppKey(GetAppKeyRequest) GetAppKeyResponse
Returns an application key
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
AddAppKey
rpc AddAppKey(AddAppKeyRequest) AddAppKeyResponse
Creates a new app key Will return key details in result, make sure to save it
RemoveAppKey
rpc RemoveAppKey(RemoveAppKeyRequest) RemoveAppKeyResponse
Removes an app key
GetProjectGrantByID
rpc GetProjectGrantByID(GetProjectGrantByIDRequest) GetProjectGrantByIDResponse
Returns a project grant (ProjectGrant = Grant another organisation for my project)
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
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
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
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
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
RemoveProjectGrant
rpc RemoveProjectGrant(RemoveProjectGrantRequest) RemoveProjectGrantResponse
Removes project grant and all user grants for this project grant
ListProjectGrantMemberRoles
rpc ListProjectGrantMemberRoles(ListProjectGrantMemberRolesRequest) ListProjectGrantMemberRolesResponse
Returns all ZITADEL roles which are for project grant managers
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
AddProjectGrantMember
rpc AddProjectGrantMember(AddProjectGrantMemberRequest) AddProjectGrantMemberResponse
Adds a new project grant manager, which is allowed to administrate in ZITADEL
UpdateProjectGrantMember
rpc UpdateProjectGrantMember(UpdateProjectGrantMemberRequest) UpdateProjectGrantMemberResponse
Changes project grant manager, which is allowed to administrate in ZITADEL
RemoveProjectGrantMember
rpc RemoveProjectGrantMember(RemoveProjectGrantMemberRequest) RemoveProjectGrantMemberResponse
Removed project grant manager
GetUserGrantByID
rpc GetUserGrantByID(GetUserGrantByIDRequest) GetUserGrantByIDResponse
Returns a user grant (authorization of a user for a project)
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
AddUserGrant
rpc AddUserGrant(AddUserGrantRequest) AddUserGrantResponse
Creates a new user grant (authorization of a user for a project with specified roles)
UpdateUserGrant
rpc UpdateUserGrant(UpdateUserGrantRequest) UpdateUserGrantResponse
Changes a user grant (authorization of a user for a project with specified roles)
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
ReactivateUserGrant
rpc ReactivateUserGrant(ReactivateUserGrantRequest) ReactivateUserGrantResponse
Sets the state of a user grant to active Returns an error if user grant is not deactivated
RemoveUserGrant
rpc RemoveUserGrant(RemoveUserGrantRequest) RemoveUserGrantResponse
Removes a user grant
BulkRemoveUserGrant
rpc BulkRemoveUserGrant(BulkRemoveUserGrantRequest) BulkRemoveUserGrantResponse
remove a list of user grants in one request
GetFeatures
rpc GetFeatures(GetFeaturesRequest) GetFeaturesResponse
GetOrgIAMPolicy
rpc GetOrgIAMPolicy(GetOrgIAMPolicyRequest) GetOrgIAMPolicyResponse
Returns the org iam policy (this policy is managed by the iam administrator)
GetLoginPolicy
rpc GetLoginPolicy(GetLoginPolicyRequest) GetLoginPolicyResponse
Returns the login policy of the organisation With this policy the login gui can be configured
GetDefaultLoginPolicy
rpc GetDefaultLoginPolicy(GetDefaultLoginPolicyRequest) GetDefaultLoginPolicyResponse
Returns the default login policy configured in the IAM
AddCustomLoginPolicy
rpc AddCustomLoginPolicy(AddCustomLoginPolicyRequest) AddCustomLoginPolicyResponse
Add a custom login policy for the organisation With this policy the login gui can be configured
UpdateCustomLoginPolicy
rpc UpdateCustomLoginPolicy(UpdateCustomLoginPolicyRequest) UpdateCustomLoginPolicyResponse
Change the custom login policy for the organisation With this policy the login gui can be configured
ResetLoginPolicyToDefault
rpc ResetLoginPolicyToDefault(ResetLoginPolicyToDefaultRequest) ResetLoginPolicyToDefaultResponse
Removes the custom login policy of the organisation The default policy of the IAM will trigger after
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
AddIDPToLoginPolicy
rpc AddIDPToLoginPolicy(AddIDPToLoginPolicyRequest) AddIDPToLoginPolicyResponse
Add a (preconfigured) identity provider to the custom login policy
RemoveIDPFromLoginPolicy
rpc RemoveIDPFromLoginPolicy(RemoveIDPFromLoginPolicyRequest) RemoveIDPFromLoginPolicyResponse
Remove a identity provider from the custom login policy
ListLoginPolicySecondFactors
rpc ListLoginPolicySecondFactors(ListLoginPolicySecondFactorsRequest) ListLoginPolicySecondFactorsResponse
Returns all configured second factors of the custom login policy
AddSecondFactorToLoginPolicy
rpc AddSecondFactorToLoginPolicy(AddSecondFactorToLoginPolicyRequest) AddSecondFactorToLoginPolicyResponse
Adds a new second factor to the custom login policy
RemoveSecondFactorFromLoginPolicy
rpc RemoveSecondFactorFromLoginPolicy(RemoveSecondFactorFromLoginPolicyRequest) RemoveSecondFactorFromLoginPolicyResponse
Remove a second factor from the custom login policy
ListLoginPolicyMultiFactors
rpc ListLoginPolicyMultiFactors(ListLoginPolicyMultiFactorsRequest) ListLoginPolicyMultiFactorsResponse
Returns all configured multi factors of the custom login policy
AddMultiFactorToLoginPolicy
rpc AddMultiFactorToLoginPolicy(AddMultiFactorToLoginPolicyRequest) AddMultiFactorToLoginPolicyResponse
Adds a new multi factor to the custom login policy
RemoveMultiFactorFromLoginPolicy
rpc RemoveMultiFactorFromLoginPolicy(RemoveMultiFactorFromLoginPolicyRequest) RemoveMultiFactorFromLoginPolicyResponse
Remove a multi factor from the custom login policy
GetPasswordComplexityPolicy
rpc GetPasswordComplexityPolicy(GetPasswordComplexityPolicyRequest) GetPasswordComplexityPolicyResponse
Returns the password complexity policy of the organisation With this policy the password strength can be configured
GetDefaultPasswordComplexityPolicy
rpc GetDefaultPasswordComplexityPolicy(GetDefaultPasswordComplexityPolicyRequest) GetDefaultPasswordComplexityPolicyResponse
Returns the default password complexity policy of the IAM With this policy the password strength can be configured
AddCustomPasswordComplexityPolicy
rpc AddCustomPasswordComplexityPolicy(AddCustomPasswordComplexityPolicyRequest) AddCustomPasswordComplexityPolicyResponse
Add a custom password complexity policy for the organisation With this policy the password strength can be configured
UpdateCustomPasswordComplexityPolicy
rpc UpdateCustomPasswordComplexityPolicy(UpdateCustomPasswordComplexityPolicyRequest) UpdateCustomPasswordComplexityPolicyResponse
Update the custom password complexity policy for the organisation With this policy the password strength can be configured
ResetPasswordComplexityPolicyToDefault
rpc ResetPasswordComplexityPolicyToDefault(ResetPasswordComplexityPolicyToDefaultRequest) ResetPasswordComplexityPolicyToDefaultResponse
Removes the custom password complexity policy of the organisation The default policy of the IAM will trigger after
GetPasswordAgePolicy
rpc GetPasswordAgePolicy(GetPasswordAgePolicyRequest) GetPasswordAgePolicyResponse
The password age policy is not used at the moment
GetDefaultPasswordAgePolicy
rpc GetDefaultPasswordAgePolicy(GetDefaultPasswordAgePolicyRequest) GetDefaultPasswordAgePolicyResponse
The password age policy is not used at the moment
AddCustomPasswordAgePolicy
rpc AddCustomPasswordAgePolicy(AddCustomPasswordAgePolicyRequest) AddCustomPasswordAgePolicyResponse
The password age policy is not used at the moment
UpdateCustomPasswordAgePolicy
rpc UpdateCustomPasswordAgePolicy(UpdateCustomPasswordAgePolicyRequest) UpdateCustomPasswordAgePolicyResponse
The password age policy is not used at the moment
ResetPasswordAgePolicyToDefault
rpc ResetPasswordAgePolicyToDefault(ResetPasswordAgePolicyToDefaultRequest) ResetPasswordAgePolicyToDefaultResponse
The password age policy is not used at the moment
GetPasswordLockoutPolicy
rpc GetPasswordLockoutPolicy(GetPasswordLockoutPolicyRequest) GetPasswordLockoutPolicyResponse
The password lockout policy is not used at the moment
GetDefaultPasswordLockoutPolicy
rpc GetDefaultPasswordLockoutPolicy(GetDefaultPasswordLockoutPolicyRequest) GetDefaultPasswordLockoutPolicyResponse
The password lockout policy is not used at the moment
AddCustomPasswordLockoutPolicy
rpc AddCustomPasswordLockoutPolicy(AddCustomPasswordLockoutPolicyRequest) AddCustomPasswordLockoutPolicyResponse
The password lockout policy is not used at the moment
UpdateCustomPasswordLockoutPolicy
rpc UpdateCustomPasswordLockoutPolicy(UpdateCustomPasswordLockoutPolicyRequest) UpdateCustomPasswordLockoutPolicyResponse
The password lockout policy is not used at the moment
ResetPasswordLockoutPolicyToDefault
rpc ResetPasswordLockoutPolicyToDefault(ResetPasswordLockoutPolicyToDefaultRequest) ResetPasswordLockoutPolicyToDefaultResponse
The password lockout policy is not used at the moment
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)
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)
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)
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)
ResetPrivacyPolicyToDefault
rpc ResetPrivacyPolicyToDefault(ResetPrivacyPolicyToDefaultRequest) ResetPrivacyPolicyToDefaultResponse
Removes the privacy policy of the organisation The default policy of the IAM will trigger after
GetLabelPolicy
rpc GetLabelPolicy(GetLabelPolicyRequest) GetLabelPolicyResponse
Returns the active label policy of the organisation With this policy the private labeling can be configured (colors, etc.)
GetPreviewLabelPolicy
rpc GetPreviewLabelPolicy(GetPreviewLabelPolicyRequest) GetPreviewLabelPolicyResponse
Returns the preview label policy of the organisation With this policy the private labeling can be configured (colors, etc.)
GetDefaultLabelPolicy
rpc GetDefaultLabelPolicy(GetDefaultLabelPolicyRequest) GetDefaultLabelPolicyResponse
Returns the default label policy of the IAM With this policy the private labeling can be configured (colors, etc.)
AddCustomLabelPolicy
rpc AddCustomLabelPolicy(AddCustomLabelPolicyRequest) AddCustomLabelPolicyResponse
Add a custom label policy for the organisation With this policy the private labeling can be configured (colors, etc.)
UpdateCustomLabelPolicy
rpc UpdateCustomLabelPolicy(UpdateCustomLabelPolicyRequest) UpdateCustomLabelPolicyResponse
Changes the custom label policy for the organisation With this policy the private labeling can be configured (colors, etc.)
ActivateCustomLabelPolicy
rpc ActivateCustomLabelPolicy(ActivateCustomLabelPolicyRequest) ActivateCustomLabelPolicyResponse
Activates all changes of the label policy
RemoveCustomLabelPolicyLogo
rpc RemoveCustomLabelPolicyLogo(RemoveCustomLabelPolicyLogoRequest) RemoveCustomLabelPolicyLogoResponse
Removes the logo of the label policy
RemoveCustomLabelPolicyLogoDark
rpc RemoveCustomLabelPolicyLogoDark(RemoveCustomLabelPolicyLogoDarkRequest) RemoveCustomLabelPolicyLogoDarkResponse
Removes the logo dark of the label policy
RemoveCustomLabelPolicyIcon
rpc RemoveCustomLabelPolicyIcon(RemoveCustomLabelPolicyIconRequest) RemoveCustomLabelPolicyIconResponse
Removes the icon of the label policy
RemoveCustomLabelPolicyIconDark
rpc RemoveCustomLabelPolicyIconDark(RemoveCustomLabelPolicyIconDarkRequest) RemoveCustomLabelPolicyIconDarkResponse
Removes the logo dark of the label policy
RemoveCustomLabelPolicyFont
rpc RemoveCustomLabelPolicyFont(RemoveCustomLabelPolicyFontRequest) RemoveCustomLabelPolicyFontResponse
Removes the font of the label policy
ResetLabelPolicyToDefault
rpc ResetLabelPolicyToDefault(ResetLabelPolicyToDefaultRequest) ResetLabelPolicyToDefaultResponse
Removes the custom label policy of the organisation The default policy of the IAM will trigger after
GetCustomInitMessageText
rpc GetCustomInitMessageText(GetCustomInitMessageTextRequest) GetCustomInitMessageTextResponse
Returns the custom text for initial message
GetDefaultInitMessageText
rpc GetDefaultInitMessageText(GetDefaultInitMessageTextRequest) GetDefaultInitMessageTextResponse
Returns the default text for initial message
SetCustomInitMessageText
rpc SetCustomInitMessageText(SetCustomInitMessageTextRequest) SetCustomInitMessageTextResponse
Sets the default custom text for initial message it impacts all organisations without customized initial message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}
ResetCustomInitMessageTextToDefault
rpc ResetCustomInitMessageTextToDefault(ResetCustomInitMessageTextToDefaultRequest) ResetCustomInitMessageTextToDefaultResponse
Removes the custom init message text of the organisation The default text of the IAM will trigger after
GetCustomPasswordResetMessageText
rpc GetCustomPasswordResetMessageText(GetCustomPasswordResetMessageTextRequest) GetCustomPasswordResetMessageTextResponse
Returns the custom text for password reset message
GetDefaultPasswordResetMessageText
rpc GetDefaultPasswordResetMessageText(GetDefaultPasswordResetMessageTextRequest) GetDefaultPasswordResetMessageTextResponse
Returns the default text for password reset message
SetCustomPasswordResetMessageText
rpc SetCustomPasswordResetMessageText(SetCustomPasswordResetMessageTextRequest) SetCustomPasswordResetMessageTextResponse
Sets the default custom text for password reset message it impacts all organisations without customized password reset message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}
ResetCustomPasswordResetMessageTextToDefault
rpc ResetCustomPasswordResetMessageTextToDefault(ResetCustomPasswordResetMessageTextToDefaultRequest) ResetCustomPasswordResetMessageTextToDefaultResponse
Removes the custom password reset message text of the organisation The default text of the IAM will trigger after
GetCustomVerifyEmailMessageText
rpc GetCustomVerifyEmailMessageText(GetCustomVerifyEmailMessageTextRequest) GetCustomVerifyEmailMessageTextResponse
Returns the custom text for verify email message
GetDefaultVerifyEmailMessageText
rpc GetDefaultVerifyEmailMessageText(GetDefaultVerifyEmailMessageTextRequest) GetDefaultVerifyEmailMessageTextResponse
Returns the default text for verify email message
SetCustomVerifyEmailMessageText
rpc SetCustomVerifyEmailMessageText(SetCustomVerifyEmailMessageTextRequest) SetCustomVerifyEmailMessageTextResponse
Sets the default custom text for verify email message it impacts all organisations without customized verify email message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}
ResetCustomVerifyEmailMessageTextToDefault
rpc ResetCustomVerifyEmailMessageTextToDefault(ResetCustomVerifyEmailMessageTextToDefaultRequest) ResetCustomVerifyEmailMessageTextToDefaultResponse
Removes the custom verify email message text of the organisation The default text of the IAM will trigger after
GetCustomVerifyPhoneMessageText
rpc GetCustomVerifyPhoneMessageText(GetCustomVerifyPhoneMessageTextRequest) GetCustomVerifyPhoneMessageTextResponse
Returns the custom text for verify email message
GetDefaultVerifyPhoneMessageText
rpc GetDefaultVerifyPhoneMessageText(GetDefaultVerifyPhoneMessageTextRequest) GetDefaultVerifyPhoneMessageTextResponse
Returns the custom text for verify email message
SetCustomVerifyPhoneMessageText
rpc SetCustomVerifyPhoneMessageText(SetCustomVerifyPhoneMessageTextRequest) SetCustomVerifyPhoneMessageTextResponse
Sets the default custom text for verify email message it impacts all organisations without customized verify email message text The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}
ResetCustomVerifyPhoneMessageTextToDefault
rpc ResetCustomVerifyPhoneMessageTextToDefault(ResetCustomVerifyPhoneMessageTextToDefaultRequest) ResetCustomVerifyPhoneMessageTextToDefaultResponse
Removes the custom verify phone text of the organisation The default text of the IAM will trigger after
GetCustomDomainClaimedMessageText
rpc GetCustomDomainClaimedMessageText(GetCustomDomainClaimedMessageTextRequest) GetCustomDomainClaimedMessageTextResponse
Returns the custom text for domain claimed message
GetDefaultDomainClaimedMessageText
rpc GetDefaultDomainClaimedMessageText(GetDefaultDomainClaimedMessageTextRequest) GetDefaultDomainClaimedMessageTextResponse
Returns the custom text for domain claimed message
SetCustomDomainClaimedMessageCustomText
rpc SetCustomDomainClaimedMessageCustomText(SetCustomDomainClaimedMessageTextRequest) SetCustomDomainClaimedMessageTextResponse
Sets the default custom text for domain claimed message it impacts all organisations without customized domain claimed message text The Following Variables can be used: {{.Domain}} {{.TempUsername}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}}
ResetCustomDomainClaimedMessageTextToDefault
rpc ResetCustomDomainClaimedMessageTextToDefault(ResetCustomDomainClaimedMessageTextToDefaultRequest) ResetCustomDomainClaimedMessageTextToDefaultResponse
Removes the custom init message text of the organisation The default text of the IAM will trigger after
GetOrgIDPByID
rpc GetOrgIDPByID(GetOrgIDPByIDRequest) GetOrgIDPByIDResponse
Returns a identity provider configuration of the organisation
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
AddOrgOIDCIDP
rpc AddOrgOIDCIDP(AddOrgOIDCIDPRequest) AddOrgOIDCIDPResponse
Add a new identity provider configuration in the organisation Provider must be OIDC compliant
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
ReactivateOrgIDP
rpc ReactivateOrgIDP(ReactivateOrgIDPRequest) ReactivateOrgIDPResponse
Activate identity provider configuration Returns error if not deactivated
RemoveOrgIDP
rpc RemoveOrgIDP(RemoveOrgIDPRequest) RemoveOrgIDPResponse
Removes identity provider configuration Will remove all linked providers of this configuration on the users
UpdateOrgIDP
rpc UpdateOrgIDP(UpdateOrgIDPRequest) UpdateOrgIDPResponse
Change identity provider configuration of the organisation
UpdateOrgIDPOIDCConfig
rpc UpdateOrgIDPOIDCConfig(UpdateOrgIDPOIDCConfigRequest) UpdateOrgIDPOIDCConfigResponse
Change OIDC identity provider configuration of the organisation
Messages
ActivateCustomLabelPolicyRequest
This is an empty request
ActivateCustomLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddAPIAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| auth_method_type | zitadel.app.v1.APIAuthMethodType | - | enum.defined_only: true |
AddAPIAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| app_id | string | - | |
| details | zitadel.v1.ObjectDetails | - | |
| client_id | string | - | |
| client_secret | string | - |
AddAppKeyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| type | zitadel.authn.v1.KeyType | - | enum.defined_only: true enum.not_in: [0] |
| expiration_date | google.protobuf.Timestamp | - |
AddAppKeyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | |
| details | zitadel.v1.ObjectDetails | - | |
| key_details | bytes | - |
AddCustomLabelPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| primary_color | string | - | string.max_len: 50 |
| hide_login_name_suffix | bool | hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set. Details about this scope in https://docs.zitadel.ch/concepts#Reserved_Scopes | |
| warn_color | string | - | string.max_len: 50 |
| background_color | string | - | string.max_len: 50 |
| font_color | string | - | string.max_len: 50 |
| primary_color_dark | string | - | string.max_len: 50 |
| background_color_dark | string | - | string.max_len: 50 |
| warn_color_dark | string | - | string.max_len: 50 |
| font_color_dark | string | - | string.max_len: 50 |
| disable_watermark | bool | - |
AddCustomLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddCustomLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| allow_username_password | bool | - | |
| allow_register | bool | - | |
| allow_external_idp | bool | - | |
| force_mfa | bool | - | |
| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true |
| hide_password_reset | bool | - |
AddCustomLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddCustomPasswordAgePolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_age_days | uint32 | - | |
| expire_warn_days | uint32 | - |
AddCustomPasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddCustomPasswordComplexityPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| min_length | uint64 | - | |
| has_uppercase | bool | - | |
| has_lowercase | bool | - | |
| has_number | bool | - | |
| has_symbol | bool | - |
AddCustomPasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddCustomPasswordLockoutPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_attempts | uint32 | - | |
| show_lockout_failure | bool | - |
AddCustomPasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddCustomPrivacyPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| tos_link | string | - | |
| privacy_link | string | - |
AddCustomPrivacyPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddHumanUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_name | string | - | string.min_len: 1 string.max_len: 200 |
| profile | AddHumanUserRequest.Profile | - | message.required: true |
| AddHumanUserRequest.Email | - | message.required: true |
|
| phone | AddHumanUserRequest.Phone | - | |
| initial_password | string | - |
AddHumanUserRequest.Email
| Field | Type | Description | Validation |
|---|---|---|---|
| string | TODO: check if no value is allowed | string.email: true |
|
| is_email_verified | bool | - |
AddHumanUserRequest.Phone
| Field | Type | Description | Validation |
|---|---|---|---|
| phone | string | has to be a global number | string.min_len: 1 string.max_len: 50 string.prefix: + |
| is_phone_verified | bool | - |
AddHumanUserRequest.Profile
| Field | Type | Description | Validation |
|---|---|---|---|
| first_name | string | - | string.min_len: 1 string.max_len: 200 |
| last_name | string | - | string.min_len: 1 string.max_len: 200 |
| nick_name | string | - | string.max_len: 200 |
| display_name | string | - | string.max_len: 200 |
| preferred_language | string | - | string.max_len: 10 |
| gender | zitadel.user.v1.Gender | - |
AddHumanUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
AddIDPToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| ownerType | zitadel.idp.v1.IDPOwnerType | - | enum.defined_only: true enum.not_in: [0] |
AddIDPToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddMachineKeyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 |
| type | zitadel.authn.v1.KeyType | - | enum.defined_only: true enum.not_in: [0] |
| expiration_date | google.protobuf.Timestamp | - |
AddMachineKeyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| key_id | string | - | |
| key_details | bytes | - | |
| details | zitadel.v1.ObjectDetails | - |
AddMachineUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_name | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| description | string | - | string.max_len: 500 |
AddMachineUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
AddMultiFactorToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true enum.not_in: [0] |
AddMultiFactorToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddOIDCAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| redirect_uris | repeated string | - | |
| response_types | repeated zitadel.app.v1.OIDCResponseType | - | |
| grant_types | repeated zitadel.app.v1.OIDCGrantType | - | |
| app_type | zitadel.app.v1.OIDCAppType | - | enum.defined_only: true |
| auth_method_type | zitadel.app.v1.OIDCAuthMethodType | - | enum.defined_only: true |
| post_logout_redirect_uris | repeated string | - | |
| version | zitadel.app.v1.OIDCVersion | - | enum.defined_only: true |
| dev_mode | bool | - | |
| access_token_type | zitadel.app.v1.OIDCTokenType | - | enum.defined_only: true |
| access_token_role_assertion | bool | - | |
| id_token_role_assertion | bool | - | |
| id_token_userinfo_assertion | bool | - | |
| clock_skew | google.protobuf.Duration | - | duration.lte.seconds: 5 duration.lte.nanos: 0 duration.gte.seconds: 0 duration.gte.nanos: 0 |
| additional_origins | repeated string | - |
AddOIDCAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| app_id | string | - | |
| details | zitadel.v1.ObjectDetails | - | |
| client_id | string | - | |
| client_secret | string | - | |
| none_compliant | bool | - | |
| compliance_problems | repeated zitadel.v1.LocalizedMessage | - |
AddOrgDomainRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
AddOrgDomainResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddOrgMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
AddOrgMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddOrgOIDCIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true |
| client_id | string | - | string.min_len: 1 string.max_len: 200 |
| client_secret | string | - | string.min_len: 1 string.max_len: 200 |
| issuer | string | - | string.min_len: 1 string.max_len: 200 |
| scopes | repeated string | - | |
| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
AddOrgOIDCIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| idp_id | string | - |
AddOrgRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
AddOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
AddProjectGrantMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
AddProjectGrantMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddProjectGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| granted_org_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_keys | repeated string | - |
AddProjectGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| grant_id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
AddProjectMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
AddProjectMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddProjectRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
| project_role_assertion | bool | - | |
| project_role_check | bool | - |
AddProjectResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
| details | zitadel.v1.ObjectDetails | - |
AddProjectRoleRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_key | string | - | string.min_len: 1 string.max_len: 200 |
| display_name | string | - | string.min_len: 1 string.max_len: 200 |
| group | string | - | string.max_len: 200 |
AddProjectRoleResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddSecondFactorToLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true enum.not_in: [0] |
AddSecondFactorToLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
AddUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| project_grant_id | string | - | string.max_len: 200 |
| role_keys | repeated string | - |
AddUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user_grant_id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
BulkAddProjectRolesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated BulkAddProjectRolesRequest.Role | - |
BulkAddProjectRolesRequest.Role
| Field | Type | Description | Validation |
|---|---|---|---|
| key | string | - | string.min_len: 1 string.max_len: 200 |
| display_name | string | - | string.min_len: 1 string.max_len: 200 |
| group | string | - | string.max_len: 200 |
BulkAddProjectRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
BulkRemoveUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| grant_id | repeated string | - |
BulkRemoveUserGrantResponse
DeactivateAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateOrgIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateOrgIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateOrgRequest
This is an empty request
DeactivateOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateProjectGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateProjectGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateProjectRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateProjectResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
DeactivateUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
DeactivateUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
GenerateOrgDomainValidationRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
| type | zitadel.org.v1.DomainValidationType | - | enum.defined_only: true enum.not_in: [0] |
GenerateOrgDomainValidationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| token | string | - | |
| url | string | - |
GetAppByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
GetAppByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| app | zitadel.app.v1.App | - |
GetAppKeyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| key_id | string | - | string.min_len: 1 string.max_len: 200 |
GetAppKeyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| key | zitadel.authn.v1.Key | - |
GetCustomDomainClaimedMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomDomainClaimedMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetCustomInitMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomInitMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetCustomPasswordResetMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomPasswordResetMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetCustomVerifyEmailMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomVerifyEmailMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetCustomVerifyPhoneMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetCustomVerifyPhoneMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetDefaultDomainClaimedMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetDefaultDomainClaimedMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetDefaultInitMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetDefaultInitMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetDefaultLabelPolicyRequest
This is an empty request
GetDefaultLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LabelPolicy | - |
GetDefaultLoginPolicyRequest
GetDefaultLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LoginPolicy | - |
GetDefaultPasswordAgePolicyRequest
This is an empty request
GetDefaultPasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordAgePolicy | - |
GetDefaultPasswordComplexityPolicyRequest
This is an empty request
GetDefaultPasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordComplexityPolicy | - |
GetDefaultPasswordLockoutPolicyRequest
This is an empty request
GetDefaultPasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordLockoutPolicy | - |
GetDefaultPasswordResetMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetDefaultPasswordResetMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetDefaultPrivacyPolicyRequest
This is an empty request
GetDefaultPrivacyPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PrivacyPolicy | - |
GetDefaultVerifyEmailMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetDefaultVerifyEmailMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetDefaultVerifyPhoneMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
GetDefaultVerifyPhoneMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| custom_text | zitadel.text.v1.MessageCustomText | - |
GetFeaturesRequest
GetFeaturesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| features | zitadel.features.v1.Features | - |
GetGrantedProjectByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
GetGrantedProjectByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| granted_project | zitadel.project.v1.GrantedProject | - |
GetHumanEmailRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
GetHumanEmailResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| zitadel.user.v1.Email | - |
GetHumanPhoneRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
GetHumanPhoneResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| phone | zitadel.user.v1.Phone | - |
GetHumanProfileRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
GetHumanProfileResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - | |
| profile | zitadel.user.v1.Profile | - |
GetIAMRequest
This is an empty request
GetIAMResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| global_org_id | string | - | |
| iam_project_id | string | - |
GetLabelPolicyRequest
This is an empty request
GetLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LabelPolicy | - | |
| is_default | bool | - |
GetLoginPolicyRequest
GetLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LoginPolicy | - | |
| is_default | bool | - |
GetMachineKeyByIDsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| key_id | string | - | string.min_len: 1 string.max_len: 200 |
GetMachineKeyByIDsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| key | zitadel.authn.v1.Key | - |
GetMyOrgRequest
This is an empty request
GetMyOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| org | zitadel.org.v1.Org | - |
GetOIDCInformationRequest
This is an empty request
GetOIDCInformationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| issuer | string | - | |
| discovery_endpoint | string | - |
GetOrgByDomainGlobalRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
GetOrgByDomainGlobalResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| org | zitadel.org.v1.Org | - |
GetOrgIAMPolicyRequest
GetOrgIAMPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.OrgIAMPolicy | - |
GetOrgIDPByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
GetOrgIDPByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| idp | zitadel.idp.v1.IDP | - |
GetPasswordAgePolicyRequest
This is an empty request
GetPasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordAgePolicy | - | |
| is_default | bool | - |
GetPasswordComplexityPolicyRequest
GetPasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordComplexityPolicy | - | |
| is_default | bool | - |
GetPasswordLockoutPolicyRequest
This is an empty request
GetPasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PasswordLockoutPolicy | - | |
| is_default | bool | - |
GetPreviewLabelPolicyRequest
This is an empty request
GetPreviewLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.LabelPolicy | - | |
| is_default | bool | - |
GetPrivacyPolicyRequest
This is an empty request
GetPrivacyPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| policy | zitadel.policy.v1.PrivacyPolicy | - |
GetProjectByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
GetProjectByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| project | zitadel.project.v1.Project | - |
GetProjectGrantByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
GetProjectGrantByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| project_grant | zitadel.project.v1.GrantedProject | - |
GetUserByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
GetUserByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user | zitadel.user.v1.User | - |
GetUserByLoginNameGlobalRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| login_name | string | - | string.min_len: 1 string.max_len: 200 |
GetUserByLoginNameGlobalResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user | zitadel.user.v1.User | - |
GetUserGrantByIDRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
GetUserGrantByIDResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user_grant | zitadel.user.v1.UserGrant | - |
HealthzRequest
This is an empty request
HealthzResponse
This is an empty response
IDPQuery
| Field | Type | Description | Validation |
|---|---|---|---|
| oneof query.idp_id_query | zitadel.idp.v1.IDPIDQuery | - | |
| oneof query.idp_name_query | zitadel.idp.v1.IDPNameQuery | - | |
| oneof query.owner_type_query | zitadel.idp.v1.IDPOwnerTypeQuery | - |
ImportHumanUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_name | string | - | string.min_len: 1 string.max_len: 200 |
| profile | ImportHumanUserRequest.Profile | - | message.required: true |
| ImportHumanUserRequest.Email | - | message.required: true |
|
| phone | ImportHumanUserRequest.Phone | - | |
| password | string | - | |
| password_change_required | bool | - |
ImportHumanUserRequest.Email
| Field | Type | Description | Validation |
|---|---|---|---|
| string | TODO: check if no value is allowed | string.email: true |
|
| is_email_verified | bool | - |
ImportHumanUserRequest.Phone
| Field | Type | Description | Validation |
|---|---|---|---|
| phone | string | has to be a global number | string.min_len: 1 string.max_len: 50 string.prefix: + |
| is_phone_verified | bool | - |
ImportHumanUserRequest.Profile
| Field | Type | Description | Validation |
|---|---|---|---|
| first_name | string | - | string.min_len: 1 string.max_len: 200 |
| last_name | string | - | string.min_len: 1 string.max_len: 200 |
| nick_name | string | - | string.max_len: 200 |
| display_name | string | - | string.max_len: 200 |
| preferred_language | string | - | string.max_len: 10 |
| gender | zitadel.user.v1.Gender | - |
ImportHumanUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | |
| details | zitadel.v1.ObjectDetails | - |
IsUserUniqueRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_name | string | - | string.max_len: 200 |
| string | - | string.max_len: 200 |
IsUserUniqueResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| is_unique | bool | - |
ListAppChangesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | |
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
ListAppChangesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.change.v1.Change | - |
ListAppKeysRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
ListAppKeysResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.authn.v1.Key | - |
ListAppsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.app.v1.AppQuery | criterias the client is looking for |
ListAppsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.app.v1.App | - |
ListGrantedProjectRolesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.project.v1.RoleQuery | criterias the client is looking for |
ListGrantedProjectRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.project.v1.Role | - |
ListGrantedProjectsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.project.v1.ProjectQuery | criterias the client is looking for |
ListGrantedProjectsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.project.v1.GrantedProject | - |
ListHumanAuthFactorsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
ListHumanAuthFactorsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| result | repeated zitadel.user.v1.AuthFactor | - |
ListHumanLinkedIDPsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering |
ListHumanLinkedIDPsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.idp.v1.IDPUserLink | - |
ListHumanPasswordlessRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
ListHumanPasswordlessResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| result | repeated zitadel.user.v1.WebAuthNToken | - |
ListLoginPolicyIDPsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | - |
ListLoginPolicyIDPsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.idp.v1.IDPLoginPolicyLink | - |
ListLoginPolicyMultiFactorsRequest
ListLoginPolicyMultiFactorsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.policy.v1.MultiFactorType | - |
ListLoginPolicySecondFactorsRequest
ListLoginPolicySecondFactorsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.policy.v1.SecondFactorType | - |
ListMachineKeysRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering |
ListMachineKeysResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.authn.v1.Key | - |
ListOrgChangesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.change.v1.ChangeQuery | list limitations and ordering |
ListOrgChangesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.change.v1.Change | - |
ListOrgDomainsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.org.v1.DomainSearchQuery | criterias the client is looking for |
ListOrgDomainsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.org.v1.Domain | - |
ListOrgIDPsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| sorting_column | zitadel.idp.v1.IDPFieldName | the field the result is sorted | |
| queries | repeated IDPQuery | criterias the client is looking for |
ListOrgIDPsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| sorting_column | zitadel.idp.v1.IDPFieldName | - | |
| result | repeated zitadel.idp.v1.IDP | - |
ListOrgMemberRolesRequest
This is an empty request
ListOrgMemberRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| result | repeated string | - |
ListOrgMembersRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for |
ListOrgMembersResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | list limitations and ordering | |
| result | repeated zitadel.member.v1.Member | criterias the client is looking for |
ListProjectChangesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | |
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
ListProjectChangesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.change.v1.Change | - |
ListProjectGrantMemberRolesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | - | |
| result | repeated string | - |
ListProjectGrantMemberRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated string | - |
ListProjectGrantMembersRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for |
ListProjectGrantMembersResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.member.v1.Member | - |
ListProjectGrantsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.project.v1.ProjectGrantQuery | criterias the client is looking for |
ListProjectGrantsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.project.v1.GrantedProject | - |
ListProjectMemberRolesRequest
This is an empty request
ListProjectMemberRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated string | - |
ListProjectMembersRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.member.v1.SearchQuery | criterias the client is looking for |
ListProjectMembersResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.member.v1.Member | - |
ListProjectRolesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.project.v1.RoleQuery | criterias the client is looking for |
ListProjectRolesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.project.v1.Role | - |
ListProjectsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.project.v1.ProjectQuery | criterias the client is looking for |
ListProjectsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.project.v1.Project | - |
ListUserChangesRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.change.v1.ChangeQuery | list limitations and ordering | |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
ListUserChangesResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.change.v1.Change | - |
ListUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| queries | repeated zitadel.user.v1.UserGrantQuery | criterias the client is looking for |
ListUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.user.v1.UserGrant | - |
ListUserMembershipsRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | list limitations and ordering | string.min_len: 1 string.max_len: 200 |
| query | zitadel.v1.ListQuery | the field the result is sorted | |
| queries | repeated zitadel.user.v1.MembershipQuery | criterias the client is looking for |
ListUserMembershipsResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| result | repeated zitadel.user.v1.Membership | - |
ListUsersRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| query | zitadel.v1.ListQuery | list limitations and ordering | |
| sorting_column | zitadel.user.v1.UserFieldName | the field the result is sorted | |
| queries | repeated zitadel.user.v1.SearchQuery | criterias the client is looking for |
ListUsersResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ListDetails | - | |
| sorting_column | zitadel.user.v1.UserFieldName | - | |
| result | repeated zitadel.user.v1.User | - |
LockUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
LockUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateOrgIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateOrgIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateOrgRequest
This is an empty request
ReactivateOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateProjectGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateProjectGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateProjectRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateProjectResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ReactivateUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
ReactivateUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RegenerateAPIClientSecretRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
RegenerateAPIClientSecretResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| client_secret | string | - | |
| details | zitadel.v1.ObjectDetails | - |
RegenerateOIDCClientSecretRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
RegenerateOIDCClientSecretResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| client_secret | string | - | |
| details | zitadel.v1.ObjectDetails | - |
RemoveAppKeyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| key_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveAppKeyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveCustomLabelPolicyFontRequest
This is an empty request
RemoveCustomLabelPolicyFontResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveCustomLabelPolicyIconDarkRequest
This is an empty request
RemoveCustomLabelPolicyIconDarkResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveCustomLabelPolicyIconRequest
This is an empty request
RemoveCustomLabelPolicyIconResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveCustomLabelPolicyLogoDarkRequest
This is an empty request
RemoveCustomLabelPolicyLogoDarkResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveCustomLabelPolicyLogoRequest
This is an empty request
RemoveCustomLabelPolicyLogoResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanAuthFactorOTPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanAuthFactorOTPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanAuthFactorU2FRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| token_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanAuthFactorU2FResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanAvatarRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanAvatarResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanLinkedIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| linked_user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanLinkedIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanPasswordlessRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| token_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanPasswordlessResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveHumanPhoneRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveHumanPhoneResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveIDPFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveIDPFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveMachineKeyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| key_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveMachineKeyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveMultiFactorFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.MultiFactorType | - | enum.defined_only: true enum.not_in: [0] |
RemoveMultiFactorFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveOrgDomainRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
RemoveOrgDomainResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveOrgIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveOrgIDPResponse
This is an empty response
RemoveOrgMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveOrgMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveProjectGrantMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveProjectGrantMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveProjectGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveProjectGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveProjectMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveProjectMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveProjectRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveProjectResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveProjectRoleRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_key | string | - | string.min_len: 1 string.max_len: 200 |
RemoveProjectRoleResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveSecondFactorFromLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| type | zitadel.policy.v1.SecondFactorType | - | enum.defined_only: true enum.not_in: [0] |
RemoveSecondFactorFromLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
RemoveUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
RemoveUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResendHumanEmailVerificationRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
ResendHumanEmailVerificationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResendHumanInitializationRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| string | - | string.email: true |
ResendHumanInitializationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResendHumanPhoneVerificationRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
ResendHumanPhoneVerificationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomDomainClaimedMessageTextToDefaultRequest
This is an empty request
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomDomainClaimedMessageTextToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomInitMessageTextToDefaultRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomInitMessageTextToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomPasswordResetMessageTextToDefaultRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomPasswordResetMessageTextToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomVerifyEmailMessageTextToDefaultRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomVerifyEmailMessageTextToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetCustomVerifyPhoneMessageTextToDefaultRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
ResetCustomVerifyPhoneMessageTextToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetLabelPolicyToDefaultRequest
This is an empty request
ResetLabelPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetLoginPolicyToDefaultRequest
ResetLoginPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetPasswordAgePolicyToDefaultRequest
This is an empty request
ResetPasswordAgePolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetPasswordComplexityPolicyToDefaultRequest
This is an empty request
ResetPasswordComplexityPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetPasswordLockoutPolicyToDefaultRequest
This is an empty request
ResetPasswordLockoutPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ResetPrivacyPolicyToDefaultRequest
This is an empty request
ResetPrivacyPolicyToDefaultResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SendHumanResetPasswordNotificationRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| type | SendHumanResetPasswordNotificationRequest.Type | - | enum.defined_only: true |
SendHumanResetPasswordNotificationResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetCustomDomainClaimedMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
| title | string | - | string.max_len: 200 |
| pre_header | string | - | string.max_len: 200 |
| subject | string | - | string.max_len: 200 |
| greeting | string | - | string.max_len: 200 |
| text | string | - | string.max_len: 800 |
| button_text | string | - | string.max_len: 200 |
| footer_text | string | - | string.max_len: 200 |
SetCustomDomainClaimedMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetCustomInitMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
| title | string | - | string.max_len: 200 |
| pre_header | string | - | string.max_len: 200 |
| subject | string | - | string.max_len: 200 |
| greeting | string | - | string.max_len: 200 |
| text | string | - | string.max_len: 800 |
| button_text | string | - | string.max_len: 200 |
| footer_text | string | - | string.max_len: 200 |
SetCustomInitMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetCustomPasswordResetMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
| title | string | - | string.max_len: 200 |
| pre_header | string | - | string.max_len: 200 |
| subject | string | - | string.max_len: 200 |
| greeting | string | - | string.max_len: 200 |
| text | string | - | string.max_len: 800 |
| button_text | string | - | string.max_len: 200 |
| footer_text | string | - | string.max_len: 200 |
SetCustomPasswordResetMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetCustomVerifyEmailMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
| title | string | - | string.max_len: 200 |
| pre_header | string | - | string.max_len: 200 |
| subject | string | - | string.max_len: 200 |
| greeting | string | - | string.max_len: 200 |
| text | string | - | string.max_len: 800 |
| button_text | string | - | string.max_len: 200 |
| footer_text | string | - | string.max_len: 200 |
SetCustomVerifyEmailMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetCustomVerifyPhoneMessageTextRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| language | string | - | string.min_len: 1 string.max_len: 200 |
| title | string | - | string.max_len: 200 |
| pre_header | string | - | string.max_len: 200 |
| subject | string | - | string.max_len: 200 |
| greeting | string | - | string.max_len: 200 |
| text | string | - | string.max_len: 800 |
| button_text | string | - | string.max_len: 200 |
| footer_text | string | - | string.max_len: 200 |
SetCustomVerifyPhoneMessageTextResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetHumanInitialPasswordRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 |
| password | string | - | string.min_len: 1 string.max_len: 72 |
SetHumanInitialPasswordResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetHumanPasswordRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 |
| password | string | - | string.min_len: 1 string.max_len: 72 |
| no_change_required | bool | - |
SetHumanPasswordResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
SetPrimaryOrgDomainRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
SetPrimaryOrgDomainResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UnlockUserRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
UnlockUserResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateAPIAppConfigRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| auth_method_type | zitadel.app.v1.APIAuthMethodType | - | enum.defined_only: true |
UpdateAPIAppConfigResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateAppRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
UpdateAppResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomLabelPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| primary_color | string | - | string.max_len: 50 |
| hide_login_name_suffix | bool | - | |
| warn_color | string | - | string.max_len: 50 |
| background_color | string | - | string.max_len: 50 |
| font_color | string | - | string.max_len: 50 |
| primary_color_dark | string | - | string.max_len: 50 |
| background_color_dark | string | - | string.max_len: 50 |
| warn_color_dark | string | - | string.max_len: 50 |
| font_color_dark | string | - | string.max_len: 50 |
| disable_watermark | bool | - |
UpdateCustomLabelPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomLoginPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| allow_username_password | bool | - | |
| allow_register | bool | - | |
| allow_external_idp | bool | - | |
| force_mfa | bool | - | |
| passwordless_type | zitadel.policy.v1.PasswordlessType | - | enum.defined_only: true |
| hide_password_reset | bool | - |
UpdateCustomLoginPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomPasswordAgePolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_age_days | uint32 | - | |
| expire_warn_days | uint32 | - |
UpdateCustomPasswordAgePolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomPasswordComplexityPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| min_length | uint64 | - | |
| has_uppercase | bool | - | |
| has_lowercase | bool | - | |
| has_number | bool | - | |
| has_symbol | bool | - |
UpdateCustomPasswordComplexityPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomPasswordLockoutPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| max_attempts | uint32 | - | |
| show_lockout_failure | bool | - |
UpdateCustomPasswordLockoutPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateCustomPrivacyPolicyRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| tos_link | string | - | |
| privacy_link | string | - |
UpdateCustomPrivacyPolicyResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateHumanEmailRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| string | - | string.email: true |
|
| is_email_verified | bool | - |
UpdateHumanEmailResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateHumanPhoneRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| phone | string | - | string.min_len: 1 string.max_len: 50 string.prefix: + |
| is_phone_verified | bool | - |
UpdateHumanPhoneResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateHumanProfileRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| first_name | string | - | string.min_len: 1 string.max_len: 200 |
| last_name | string | - | string.min_len: 1 string.max_len: 200 |
| nick_name | string | - | string.max_len: 200 |
| display_name | string | - | string.min_len: 1 string.max_len: 200 |
| preferred_language | string | - | string.max_len: 10 |
| gender | zitadel.user.v1.Gender | - |
UpdateHumanProfileResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateMachineRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| description | string | - | string.max_len: 500 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
UpdateMachineResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOIDCAppConfigRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| app_id | string | - | string.min_len: 1 string.max_len: 200 |
| redirect_uris | repeated string | - | |
| response_types | repeated zitadel.app.v1.OIDCResponseType | - | |
| grant_types | repeated zitadel.app.v1.OIDCGrantType | - | |
| app_type | zitadel.app.v1.OIDCAppType | - | enum.defined_only: true |
| auth_method_type | zitadel.app.v1.OIDCAuthMethodType | - | enum.defined_only: true |
| post_logout_redirect_uris | repeated string | - | |
| dev_mode | bool | - | |
| access_token_type | zitadel.app.v1.OIDCTokenType | - | enum.defined_only: true |
| access_token_role_assertion | bool | - | |
| id_token_role_assertion | bool | - | |
| id_token_userinfo_assertion | bool | - | |
| clock_skew | google.protobuf.Duration | - | duration.lte.seconds: 5 duration.lte.nanos: 0 duration.gte.seconds: 0 duration.gte.nanos: 0 |
| additional_origins | repeated string | - |
UpdateOIDCAppConfigResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOrgIDPOIDCConfigRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| client_id | string | - | string.min_len: 1 string.max_len: 200 |
| client_secret | string | - | string.max_len: 200 |
| issuer | string | - | string.min_len: 1 string.max_len: 200 |
| scopes | repeated string | - | |
| display_name_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
| username_mapping | zitadel.idp.v1.OIDCMappingField | - | enum.defined_only: true |
UpdateOrgIDPOIDCConfigResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOrgIDPRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| idp_id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| styling_type | zitadel.idp.v1.IDPStylingType | - | enum.defined_only: true |
UpdateOrgIDPResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOrgMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
UpdateOrgMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateOrgRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| name | string | - | string.min_len: 1 string.max_len: 200 |
UpdateOrgResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateProjectGrantMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
UpdateProjectGrantMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateProjectGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_keys | repeated string | - |
UpdateProjectGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateProjectMemberRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| roles | repeated string | - |
UpdateProjectMemberResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateProjectRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| id | string | - | string.min_len: 1 string.max_len: 200 |
| name | string | - | string.min_len: 1 string.max_len: 200 |
| project_role_assertion | bool | - | |
| project_role_check | bool | - |
UpdateProjectResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateProjectRoleRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| project_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_key | string | - | string.min_len: 1 string.max_len: 200 |
| display_name | string | - | string.min_len: 1 string.max_len: 200 |
| group | string | - | string.max_len: 200 |
UpdateProjectRoleResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateUserGrantRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| grant_id | string | - | string.min_len: 1 string.max_len: 200 |
| role_keys | repeated string | - |
UpdateUserGrantResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
UpdateUserNameRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| user_id | string | - | string.min_len: 1 string.max_len: 200 |
| user_name | string | - | string.min_len: 1 string.max_len: 200 |
UpdateUserNameResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |
ValidateOrgDomainRequest
| Field | Type | Description | Validation |
|---|---|---|---|
| domain | string | - | string.min_len: 1 string.max_len: 200 |
ValidateOrgDomainResponse
| Field | Type | Description | Validation |
|---|---|---|---|
| details | zitadel.v1.ObjectDetails | - |