Specs

activate_custom_label_policy(
  input :: Zitadel.Management.V1.ActivateCustomLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ActivateCustomLabelPolicyResponse.t()

Activates all changes of the label policy

Specs

add_api_app(
  input :: Zitadel.Management.V1.AddAPIAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddAPIAppResponse.t()

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

Specs

add_app_key(
  input :: Zitadel.Management.V1.AddAppKeyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddAppKeyResponse.t()

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

Specs

add_custom_label_policy(
  input :: Zitadel.Management.V1.AddCustomLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomLabelPolicyResponse.t()

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

Specs

add_custom_lockout_policy(
  input :: Zitadel.Management.V1.AddCustomLockoutPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomLockoutPolicyResponse.t()

Specs

add_custom_login_policy(
  input :: Zitadel.Management.V1.AddCustomLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomLoginPolicyResponse.t()

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

Specs

add_custom_password_age_policy(
  input :: Zitadel.Management.V1.AddCustomPasswordAgePolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomPasswordAgePolicyResponse.t()

The password age policy is not used at the moment

Specs

add_custom_password_complexity_policy(
  input :: Zitadel.Management.V1.AddCustomPasswordComplexityPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomPasswordComplexityPolicyResponse.t()

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

Specs

add_custom_privacy_policy(
  input :: Zitadel.Management.V1.AddCustomPrivacyPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddCustomPrivacyPolicyResponse.t()

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

Specs

add_human_user(
  input :: Zitadel.Management.V1.AddHumanUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddHumanUserResponse.t()

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

Specs

add_idp_to_login_policy(
  input :: Zitadel.Management.V1.AddIDPToLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddIDPToLoginPolicyResponse.t()

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

Specs

add_machine_key(
  input :: Zitadel.Management.V1.AddMachineKeyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddMachineKeyResponse.t()

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

Specs

add_machine_user(
  input :: Zitadel.Management.V1.AddMachineUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddMachineUserResponse.t()

Create a user of the type machine

Specs

add_multi_factor_to_login_policy(
  input :: Zitadel.Management.V1.AddMultiFactorToLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddMultiFactorToLoginPolicyResponse.t()

Adds a new multi factor to the custom login policy

Specs

add_oidc_app(
  input :: Zitadel.Management.V1.AddOIDCAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOIDCAppResponse.t()

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

Specs

add_org(
  input :: Zitadel.Management.V1.AddOrgRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOrgResponse.t()

Creates a new organisation

Specs

add_org_domain(
  input :: Zitadel.Management.V1.AddOrgDomainRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOrgDomainResponse.t()

Adds a new domain to my organisation

Specs

add_org_jwtidp(
  input :: Zitadel.Management.V1.AddOrgJWTIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOrgJWTIDPResponse.t()

Add a new jwt identity provider configuration in the organisation

Specs

add_org_member(
  input :: Zitadel.Management.V1.AddOrgMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOrgMemberResponse.t()

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

Specs

add_org_oidcidp(
  input :: Zitadel.Management.V1.AddOrgOIDCIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddOrgOIDCIDPResponse.t()

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

Specs

add_passwordless_registration(
  input :: Zitadel.Management.V1.AddPasswordlessRegistrationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddPasswordlessRegistrationResponse.t()

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

Specs

add_project(
  input :: Zitadel.Management.V1.AddProjectRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddProjectResponse.t()

Adds an new project to the organisation

Specs

add_project_grant(
  input :: Zitadel.Management.V1.AddProjectGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddProjectGrantResponse.t()

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

Specs

add_project_grant_member(
  input :: Zitadel.Management.V1.AddProjectGrantMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddProjectGrantMemberResponse.t()

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

Specs

add_project_member(
  input :: Zitadel.Management.V1.AddProjectMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddProjectMemberResponse.t()

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

Specs

add_project_role(
  input :: Zitadel.Management.V1.AddProjectRoleRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddProjectRoleResponse.t()

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

Specs

add_second_factor_to_login_policy(
  input :: Zitadel.Management.V1.AddSecondFactorToLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddSecondFactorToLoginPolicyResponse.t()

Adds a new second factor to the custom login policy

Specs

add_user_grant(
  input :: Zitadel.Management.V1.AddUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.AddUserGrantResponse.t()

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

Specs

bulk_add_project_roles(
  input :: Zitadel.Management.V1.BulkAddProjectRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.BulkAddProjectRolesResponse.t()

add a list of project roles in one request

Specs

bulk_remove_user_grant(
  input :: Zitadel.Management.V1.BulkRemoveUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.BulkRemoveUserGrantResponse.t()

remove a list of user grants in one request

Specs

bulk_remove_user_metadata(
  input :: Zitadel.Management.V1.BulkRemoveUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.BulkRemoveUserMetadataResponse.t()

Set a list of user metadata

Specs

bulk_set_user_metadata(
  input :: Zitadel.Management.V1.BulkSetUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.BulkSetUserMetadataResponse.t()

Set a list of user metadata

Specs

clear_flow(
  input :: Zitadel.Management.V1.ClearFlowRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ClearFlowResponse.t()

Specs

create_action(
  input :: Zitadel.Management.V1.CreateActionRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.CreateActionResponse.t()

Specs

deactivate_app(
  input :: Zitadel.Management.V1.DeactivateAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateAppResponse.t()

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

Specs

deactivate_org(
  input :: Zitadel.Management.V1.DeactivateOrgRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateOrgResponse.t()

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

Specs

deactivate_org_idp(
  input :: Zitadel.Management.V1.DeactivateOrgIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateOrgIDPResponse.t()

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

Specs

deactivate_project(
  input :: Zitadel.Management.V1.DeactivateProjectRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateProjectResponse.t()

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

Specs

deactivate_project_grant(
  input :: Zitadel.Management.V1.DeactivateProjectGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateProjectGrantResponse.t()

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

Specs

deactivate_user(
  input :: Zitadel.Management.V1.DeactivateUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateUserResponse.t()

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

Specs

deactivate_user_grant(
  input :: Zitadel.Management.V1.DeactivateUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeactivateUserGrantResponse.t()

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

Specs

delete_action(
  input :: Zitadel.Management.V1.DeleteActionRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.DeleteActionResponse.t()

TODO: enable in next release rpc DeactivateAction(DeactivateActionRequest) returns (DeactivateActionResponse) {

   option (google.api.http) = {
       post: "/actions/{id}/_deactivate"
       body: "*"
   };

   option (zitadel.v1.auth_option) = {
       permission: "org.action.write"
       feature: "actions"
   };

}

rpc ReactivateAction(ReactivateActionRequest) returns (ReactivateActionResponse) {

   option (google.api.http) = {
       post: "/actions/{id}/_reactivate"
       body: "*"
   };

   option (zitadel.v1.auth_option) = {
       permission: "org.action.write"
       feature: "actions"
   };

}

Specs

generate_org_domain_validation(
  input :: Zitadel.Management.V1.GenerateOrgDomainValidationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GenerateOrgDomainValidationResponse.t()

Generates a new file to validate you domain

Specs

get_action(
  input :: Zitadel.Management.V1.GetActionRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetActionResponse.t()

Specs

get_app_by_id(
  input :: Zitadel.Management.V1.GetAppByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetAppByIDResponse.t()

Returns an application (oidc or api)

Specs

get_app_key(
  input :: Zitadel.Management.V1.GetAppKeyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetAppKeyResponse.t()

Returns an application key

Specs

get_custom_domain_claimed_message_text(
  input :: Zitadel.Management.V1.GetCustomDomainClaimedMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomDomainClaimedMessageTextResponse.t()

Returns the custom text for domain claimed message

Specs

get_custom_init_message_text(
  input :: Zitadel.Management.V1.GetCustomInitMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomInitMessageTextResponse.t()

Returns the custom text for initial message

Specs

get_custom_login_texts(
  input :: Zitadel.Management.V1.GetCustomLoginTextsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomLoginTextsResponse.t()

Returns the custom texts for login ui

Specs

get_custom_password_reset_message_text(
  input :: Zitadel.Management.V1.GetCustomPasswordResetMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomPasswordResetMessageTextResponse.t()

Returns the custom text for password reset message

Specs

get_custom_passwordless_registration_message_text(
  input ::
    Zitadel.Management.V1.GetCustomPasswordlessRegistrationMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.GetCustomPasswordlessRegistrationMessageTextResponse.t()

Returns the custom text for passwordless link message

Specs

get_custom_verify_email_message_text(
  input :: Zitadel.Management.V1.GetCustomVerifyEmailMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomVerifyEmailMessageTextResponse.t()

Returns the custom text for verify email message

Specs

get_custom_verify_phone_message_text(
  input :: Zitadel.Management.V1.GetCustomVerifyPhoneMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetCustomVerifyPhoneMessageTextResponse.t()

Returns the custom text for verify email message

Specs

get_default_domain_claimed_message_text(
  input :: Zitadel.Management.V1.GetDefaultDomainClaimedMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultDomainClaimedMessageTextResponse.t()

Returns the custom text for domain claimed message

Specs

get_default_init_message_text(
  input :: Zitadel.Management.V1.GetDefaultInitMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultInitMessageTextResponse.t()

Returns the default text for initial message

Specs

get_default_label_policy(
  input :: Zitadel.Management.V1.GetDefaultLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultLabelPolicyResponse.t()

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

Specs

get_default_lockout_policy(
  input :: Zitadel.Management.V1.GetDefaultLockoutPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultLockoutPolicyResponse.t()

Specs

get_default_login_policy(
  input :: Zitadel.Management.V1.GetDefaultLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultLoginPolicyResponse.t()

Returns the default login policy configured in the IAM

Specs

get_default_login_texts(
  input :: Zitadel.Management.V1.GetDefaultLoginTextsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultLoginTextsResponse.t()

Returns the custom texts for login ui

Specs

get_default_password_age_policy(
  input :: Zitadel.Management.V1.GetDefaultPasswordAgePolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultPasswordAgePolicyResponse.t()

The password age policy is not used at the moment

Specs

get_default_password_complexity_policy(
  input :: Zitadel.Management.V1.GetDefaultPasswordComplexityPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultPasswordComplexityPolicyResponse.t()

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

Specs

get_default_password_reset_message_text(
  input :: Zitadel.Management.V1.GetDefaultPasswordResetMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultPasswordResetMessageTextResponse.t()

Returns the default text for password reset message

Specs

get_default_passwordless_registration_message_text(
  input ::
    Zitadel.Management.V1.GetDefaultPasswordlessRegistrationMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.GetDefaultPasswordlessRegistrationMessageTextResponse.t()

Returns the custom text for passwordless link message

Specs

get_default_privacy_policy(
  input :: Zitadel.Management.V1.GetDefaultPrivacyPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultPrivacyPolicyResponse.t()

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

Specs

get_default_verify_email_message_text(
  input :: Zitadel.Management.V1.GetDefaultVerifyEmailMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultVerifyEmailMessageTextResponse.t()

Returns the default text for verify email message

Specs

get_default_verify_phone_message_text(
  input :: Zitadel.Management.V1.GetDefaultVerifyPhoneMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetDefaultVerifyPhoneMessageTextResponse.t()

Returns the custom text for verify email message

Specs

get_features(
  input :: Zitadel.Management.V1.GetFeaturesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetFeaturesResponse.t()

Specs

get_flow(
  input :: Zitadel.Management.V1.GetFlowRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetFlowResponse.t()

Specs

get_granted_project_by_id(
  input :: Zitadel.Management.V1.GetGrantedProjectByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetGrantedProjectByIDResponse.t()

returns a project my organisation got granted from another organisation

Specs

get_human_email(
  input :: Zitadel.Management.V1.GetHumanEmailRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetHumanEmailResponse.t()

GetHumanEmail returns the email and verified state of the human

Specs

get_human_phone(
  input :: Zitadel.Management.V1.GetHumanPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetHumanPhoneResponse.t()

Returns the phone and verified state of the human phone

Specs

get_human_profile(
  input :: Zitadel.Management.V1.GetHumanProfileRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetHumanProfileResponse.t()

Returns the profile of the human

Specs

get_iam(
  input :: Zitadel.Management.V1.GetIAMRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetIAMResponse.t()

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

Specs

get_label_policy(
  input :: Zitadel.Management.V1.GetLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetLabelPolicyResponse.t()

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

Specs

get_lockout_policy(
  input :: Zitadel.Management.V1.GetLockoutPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetLockoutPolicyResponse.t()

Specs

get_login_policy(
  input :: Zitadel.Management.V1.GetLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetLoginPolicyResponse.t()

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

Specs

get_machine_key_by_i_ds(
  input :: Zitadel.Management.V1.GetMachineKeyByIDsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetMachineKeyByIDsResponse.t()

Returns a machine key of a (machine) user

Specs

get_my_org(
  input :: Zitadel.Management.V1.GetMyOrgRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetMyOrgResponse.t()

Returns the org given in the header

Specs

get_oidc_information(
  input :: Zitadel.Management.V1.GetOIDCInformationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetOIDCInformationResponse.t()

Specs

get_org_by_domain_global(
  input :: Zitadel.Management.V1.GetOrgByDomainGlobalRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetOrgByDomainGlobalResponse.t()

Search a org over all organisations Domain must match exactly

Specs

get_org_iam_policy(
  input :: Zitadel.Management.V1.GetOrgIAMPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetOrgIAMPolicyResponse.t()

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

Specs

get_org_idp_by_id(
  input :: Zitadel.Management.V1.GetOrgIDPByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetOrgIDPByIDResponse.t()

Returns a identity provider configuration of the organisation

Specs

get_password_age_policy(
  input :: Zitadel.Management.V1.GetPasswordAgePolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetPasswordAgePolicyResponse.t()

The password age policy is not used at the moment

Specs

get_password_complexity_policy(
  input :: Zitadel.Management.V1.GetPasswordComplexityPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetPasswordComplexityPolicyResponse.t()

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

Specs

get_preview_label_policy(
  input :: Zitadel.Management.V1.GetPreviewLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetPreviewLabelPolicyResponse.t()

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

Specs

get_privacy_policy(
  input :: Zitadel.Management.V1.GetPrivacyPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetPrivacyPolicyResponse.t()

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

Specs

get_project_by_id(
  input :: Zitadel.Management.V1.GetProjectByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetProjectByIDResponse.t()

Returns a project from my organisation (no granted projects)

Specs

get_project_grant_by_id(
  input :: Zitadel.Management.V1.GetProjectGrantByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetProjectGrantByIDResponse.t()

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

Specs

get_supported_languages(
  input :: Zitadel.Management.V1.GetSupportedLanguagesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetSupportedLanguagesResponse.t()

Returns the default languages

Specs

get_user_by_id(
  input :: Zitadel.Management.V1.GetUserByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetUserByIDResponse.t()

Returns the requested full blown user (human or machine)

Specs

get_user_by_login_name_global(
  input :: Zitadel.Management.V1.GetUserByLoginNameGlobalRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetUserByLoginNameGlobalResponse.t()

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

Specs

get_user_grant_by_id(
  input :: Zitadel.Management.V1.GetUserGrantByIDRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetUserGrantByIDResponse.t()

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

Specs

get_user_metadata(
  input :: Zitadel.Management.V1.GetUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.GetUserMetadataResponse.t()

Returns the user metadata by key

Specs

healthz(
  input :: Zitadel.Management.V1.HealthzRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.HealthzResponse.t()

Specs

import_human_user(
  input :: Zitadel.Management.V1.ImportHumanUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ImportHumanUserResponse.t()

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

Specs

is_user_unique(
  input :: Zitadel.Management.V1.IsUserUniqueRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.IsUserUniqueResponse.t()

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

Specs

list_actions(
  input :: Zitadel.Management.V1.ListActionsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListActionsResponse.t()

Specs

list_all_project_grants(
  input :: Zitadel.Management.V1.ListAllProjectGrantsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListAllProjectGrantsResponse.t()

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

Specs

list_app_changes(
  input :: Zitadel.Management.V1.ListAppChangesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListAppChangesResponse.t()

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

Specs

list_app_keys(
  input :: Zitadel.Management.V1.ListAppKeysRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListAppKeysResponse.t()

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

Specs

list_apps(
  input :: Zitadel.Management.V1.ListAppsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListAppsResponse.t()

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

Specs

list_granted_project_roles(
  input :: Zitadel.Management.V1.ListGrantedProjectRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListGrantedProjectRolesResponse.t()

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

Specs

list_granted_projects(
  input :: Zitadel.Management.V1.ListGrantedProjectsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListGrantedProjectsResponse.t()

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

Specs

list_human_auth_factors(
  input :: Zitadel.Management.V1.ListHumanAuthFactorsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListHumanAuthFactorsResponse.t()

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

Specs

list_human_linked_id_ps(
  input :: Zitadel.Management.V1.ListHumanLinkedIDPsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListHumanLinkedIDPsResponse.t()

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

Specs

list_human_passwordless(
  input :: Zitadel.Management.V1.ListHumanPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListHumanPasswordlessResponse.t()

Returns all configured passwordless authenticators

Specs

list_login_policy_id_ps(
  input :: Zitadel.Management.V1.ListLoginPolicyIDPsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListLoginPolicyIDPsResponse.t()

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

Specs

list_login_policy_multi_factors(
  input :: Zitadel.Management.V1.ListLoginPolicyMultiFactorsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListLoginPolicyMultiFactorsResponse.t()

Returns all configured multi factors of the custom login policy

Specs

list_login_policy_second_factors(
  input :: Zitadel.Management.V1.ListLoginPolicySecondFactorsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListLoginPolicySecondFactorsResponse.t()

Returns all configured second factors of the custom login policy

Specs

list_machine_keys(
  input :: Zitadel.Management.V1.ListMachineKeysRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListMachineKeysResponse.t()

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

Specs

list_org_changes(
  input :: Zitadel.Management.V1.ListOrgChangesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListOrgChangesResponse.t()

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

Specs

list_org_domains(
  input :: Zitadel.Management.V1.ListOrgDomainsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListOrgDomainsResponse.t()

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

Specs

list_org_id_ps(
  input :: Zitadel.Management.V1.ListOrgIDPsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListOrgIDPsResponse.t()

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

Specs

list_org_member_roles(
  input :: Zitadel.Management.V1.ListOrgMemberRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListOrgMemberRolesResponse.t()

Returns all ZITADEL roles which are for organisation managers

Specs

list_org_members(
  input :: Zitadel.Management.V1.ListOrgMembersRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListOrgMembersResponse.t()

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

Specs

list_project_changes(
  input :: Zitadel.Management.V1.ListProjectChangesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectChangesResponse.t()

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

Specs

list_project_grant_member_roles(
  input :: Zitadel.Management.V1.ListProjectGrantMemberRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectGrantMemberRolesResponse.t()

Returns all ZITADEL roles which are for project grant managers

Specs

list_project_grant_members(
  input :: Zitadel.Management.V1.ListProjectGrantMembersRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectGrantMembersResponse.t()

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

Specs

list_project_grants(
  input :: Zitadel.Management.V1.ListProjectGrantsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectGrantsResponse.t()

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

Specs

list_project_member_roles(
  input :: Zitadel.Management.V1.ListProjectMemberRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectMemberRolesResponse.t()

Returns all ZITADEL roles which are for project managers

Specs

list_project_members(
  input :: Zitadel.Management.V1.ListProjectMembersRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectMembersResponse.t()

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

Specs

list_project_roles(
  input :: Zitadel.Management.V1.ListProjectRolesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectRolesResponse.t()

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

Specs

list_projects(
  input :: Zitadel.Management.V1.ListProjectsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListProjectsResponse.t()

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

Specs

list_user_changes(
  input :: Zitadel.Management.V1.ListUserChangesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListUserChangesResponse.t()

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

Specs

list_user_grants(
  input :: Zitadel.Management.V1.ListUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListUserGrantResponse.t()

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

Specs

list_user_memberships(
  input :: Zitadel.Management.V1.ListUserMembershipsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListUserMembershipsResponse.t()

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

Specs

list_user_metadata(
  input :: Zitadel.Management.V1.ListUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListUserMetadataResponse.t()

Returns the user metadata

Specs

list_users(
  input :: Zitadel.Management.V1.ListUsersRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ListUsersResponse.t()

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

Specs

lock_user(
  input :: Zitadel.Management.V1.LockUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.LockUserResponse.t()

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

Specs

reactivate_app(
  input :: Zitadel.Management.V1.ReactivateAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateAppResponse.t()

Set the state to active Returns an error if not deactivated

Specs

reactivate_org(
  input :: Zitadel.Management.V1.ReactivateOrgRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateOrgResponse.t()

Sets the state of my organisation to active

Specs

reactivate_org_idp(
  input :: Zitadel.Management.V1.ReactivateOrgIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateOrgIDPResponse.t()

Activate identity provider configuration Returns error if not deactivated

Specs

reactivate_project(
  input :: Zitadel.Management.V1.ReactivateProjectRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateProjectResponse.t()

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

Specs

reactivate_project_grant(
  input :: Zitadel.Management.V1.ReactivateProjectGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateProjectGrantResponse.t()

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

Specs

reactivate_user(
  input :: Zitadel.Management.V1.ReactivateUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateUserResponse.t()

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

Specs

reactivate_user_grant(
  input :: Zitadel.Management.V1.ReactivateUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ReactivateUserGrantResponse.t()

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

Specs

regenerate_api_client_secret(
  input :: Zitadel.Management.V1.RegenerateAPIClientSecretRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RegenerateAPIClientSecretResponse.t()

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

Specs

regenerate_oidc_client_secret(
  input :: Zitadel.Management.V1.RegenerateOIDCClientSecretRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RegenerateOIDCClientSecretResponse.t()

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

Specs

remove_app(
  input :: Zitadel.Management.V1.RemoveAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveAppResponse.t()

Removed the application

Specs

remove_app_key(
  input :: Zitadel.Management.V1.RemoveAppKeyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveAppKeyResponse.t()

Removes an app key

Specs

remove_custom_label_policy_font(
  input :: Zitadel.Management.V1.RemoveCustomLabelPolicyFontRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveCustomLabelPolicyFontResponse.t()

Removes the font of the label policy

Specs

remove_custom_label_policy_icon(
  input :: Zitadel.Management.V1.RemoveCustomLabelPolicyIconRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveCustomLabelPolicyIconResponse.t()

Removes the icon of the label policy

Specs

remove_custom_label_policy_icon_dark(
  input :: Zitadel.Management.V1.RemoveCustomLabelPolicyIconDarkRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveCustomLabelPolicyIconDarkResponse.t()

Removes the logo dark of the label policy

Specs

remove_custom_label_policy_logo(
  input :: Zitadel.Management.V1.RemoveCustomLabelPolicyLogoRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveCustomLabelPolicyLogoResponse.t()

Removes the logo of the label policy

Specs

remove_custom_label_policy_logo_dark(
  input :: Zitadel.Management.V1.RemoveCustomLabelPolicyLogoDarkRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveCustomLabelPolicyLogoDarkResponse.t()

Removes the logo dark of the label policy

Specs

remove_human_auth_factor_otp(
  input :: Zitadel.Management.V1.RemoveHumanAuthFactorOTPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanAuthFactorOTPResponse.t()

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

Specs

remove_human_auth_factor_u2_f(
  input :: Zitadel.Management.V1.RemoveHumanAuthFactorU2FRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanAuthFactorU2FResponse.t()

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

Specs

remove_human_avatar(
  input :: Zitadel.Management.V1.RemoveHumanAvatarRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanAvatarResponse.t()

Removes the avatar number of the human

Specs

remove_human_linked_idp(
  input :: Zitadel.Management.V1.RemoveHumanLinkedIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanLinkedIDPResponse.t()

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

Specs

remove_human_passwordless(
  input :: Zitadel.Management.V1.RemoveHumanPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanPasswordlessResponse.t()

Removed a configured passwordless authenticator

Specs

remove_human_phone(
  input :: Zitadel.Management.V1.RemoveHumanPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveHumanPhoneResponse.t()

Removes the phone number of the human

Specs

remove_idp_from_login_policy(
  input :: Zitadel.Management.V1.RemoveIDPFromLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveIDPFromLoginPolicyResponse.t()

Remove a identity provider from the custom login policy

Specs

remove_machine_key(
  input :: Zitadel.Management.V1.RemoveMachineKeyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveMachineKeyResponse.t()

Removed a machine key

Specs

remove_multi_factor_from_login_policy(
  input :: Zitadel.Management.V1.RemoveMultiFactorFromLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveMultiFactorFromLoginPolicyResponse.t()

Remove a multi factor from the custom login policy

Specs

remove_org_domain(
  input :: Zitadel.Management.V1.RemoveOrgDomainRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveOrgDomainResponse.t()

Removed the domain from my organisation

Specs

remove_org_idp(
  input :: Zitadel.Management.V1.RemoveOrgIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveOrgIDPResponse.t()

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

Specs

remove_org_member(
  input :: Zitadel.Management.V1.RemoveOrgMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveOrgMemberResponse.t()

Removes an organisation manager

Specs

remove_project(
  input :: Zitadel.Management.V1.RemoveProjectRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveProjectResponse.t()

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

Specs

remove_project_grant(
  input :: Zitadel.Management.V1.RemoveProjectGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveProjectGrantResponse.t()

Removes project grant and all user grants for this project grant

Specs

remove_project_grant_member(
  input :: Zitadel.Management.V1.RemoveProjectGrantMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveProjectGrantMemberResponse.t()

Removed project grant manager

Specs

remove_project_member(
  input :: Zitadel.Management.V1.RemoveProjectMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveProjectMemberResponse.t()

Remove project manager, which is allowed to administrate in ZITADEL

Specs

remove_project_role(
  input :: Zitadel.Management.V1.RemoveProjectRoleRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveProjectRoleResponse.t()

Removes role from UserGrants, ProjectGrants and from Project

Specs

remove_second_factor_from_login_policy(
  input :: Zitadel.Management.V1.RemoveSecondFactorFromLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveSecondFactorFromLoginPolicyResponse.t()

Remove a second factor from the custom login policy

Specs

remove_user(
  input :: Zitadel.Management.V1.RemoveUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveUserResponse.t()

Changes the user state to deleted

Specs

remove_user_grant(
  input :: Zitadel.Management.V1.RemoveUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveUserGrantResponse.t()

Removes a user grant

Specs

remove_user_metadata(
  input :: Zitadel.Management.V1.RemoveUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.RemoveUserMetadataResponse.t()

Removes a user metadata by key

Specs

resend_human_email_verification(
  input :: Zitadel.Management.V1.ResendHumanEmailVerificationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResendHumanEmailVerificationResponse.t()

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

Specs

resend_human_initialization(
  input :: Zitadel.Management.V1.ResendHumanInitializationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResendHumanInitializationResponse.t()

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

Specs

resend_human_phone_verification(
  input :: Zitadel.Management.V1.ResendHumanPhoneVerificationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResendHumanPhoneVerificationResponse.t()

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

Specs

reset_custom_domain_claimed_message_text_to_default(
  input ::
    Zitadel.Management.V1.ResetCustomDomainClaimedMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.ResetCustomDomainClaimedMessageTextToDefaultResponse.t()

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

Specs

reset_custom_init_message_text_to_default(
  input :: Zitadel.Management.V1.ResetCustomInitMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetCustomInitMessageTextToDefaultResponse.t()

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

Specs

reset_custom_login_text_to_default(
  input :: Zitadel.Management.V1.ResetCustomLoginTextsToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetCustomLoginTextsToDefaultResponse.t()

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

Specs

reset_custom_password_reset_message_text_to_default(
  input ::
    Zitadel.Management.V1.ResetCustomPasswordResetMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.ResetCustomPasswordResetMessageTextToDefaultResponse.t()

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

Specs

reset_custom_passwordless_registration_message_text_to_default(
  input ::
    Zitadel.Management.V1.ResetCustomPasswordlessRegistrationMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.ResetCustomPasswordlessRegistrationMessageTextToDefaultResponse.t()

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

Specs

reset_custom_verify_email_message_text_to_default(
  input ::
    Zitadel.Management.V1.ResetCustomVerifyEmailMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.ResetCustomVerifyEmailMessageTextToDefaultResponse.t()

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

Specs

reset_custom_verify_phone_message_text_to_default(
  input ::
    Zitadel.Management.V1.ResetCustomVerifyPhoneMessageTextToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.ResetCustomVerifyPhoneMessageTextToDefaultResponse.t()

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

Specs

reset_label_policy_to_default(
  input :: Zitadel.Management.V1.ResetLabelPolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetLabelPolicyToDefaultResponse.t()

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

Specs

reset_lockout_policy_to_default(
  input :: Zitadel.Management.V1.ResetLockoutPolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetLockoutPolicyToDefaultResponse.t()

Specs

reset_login_policy_to_default(
  input :: Zitadel.Management.V1.ResetLoginPolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetLoginPolicyToDefaultResponse.t()

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

Specs

reset_password_age_policy_to_default(
  input :: Zitadel.Management.V1.ResetPasswordAgePolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetPasswordAgePolicyToDefaultResponse.t()

The password age policy is not used at the moment

Specs

reset_password_complexity_policy_to_default(
  input ::
    Zitadel.Management.V1.ResetPasswordComplexityPolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetPasswordComplexityPolicyToDefaultResponse.t()

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

Specs

reset_privacy_policy_to_default(
  input :: Zitadel.Management.V1.ResetPrivacyPolicyToDefaultRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ResetPrivacyPolicyToDefaultResponse.t()

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

Specs

send_human_reset_password_notification(
  input :: Zitadel.Management.V1.SendHumanResetPasswordNotificationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SendHumanResetPasswordNotificationResponse.t()

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

Specs

send_passwordless_registration(
  input :: Zitadel.Management.V1.SendPasswordlessRegistrationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SendPasswordlessRegistrationResponse.t()

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

Specs

set_custom_domain_claimed_message_custom_text(
  input :: Zitadel.Management.V1.SetCustomDomainClaimedMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomDomainClaimedMessageTextResponse.t()

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

Specs

set_custom_init_message_text(
  input :: Zitadel.Management.V1.SetCustomInitMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomInitMessageTextResponse.t()

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

Specs

set_custom_login_text(
  input :: Zitadel.Management.V1.SetCustomLoginTextsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomLoginTextsResponse.t()

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

Specs

set_custom_password_reset_message_text(
  input :: Zitadel.Management.V1.SetCustomPasswordResetMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomPasswordResetMessageTextResponse.t()

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

Specs

set_custom_passwordless_registration_message_custom_text(
  input ::
    Zitadel.Management.V1.SetCustomPasswordlessRegistrationMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) ::
  Zitadel.Management.V1.SetCustomPasswordlessRegistrationMessageTextResponse.t()

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

Specs

set_custom_verify_email_message_text(
  input :: Zitadel.Management.V1.SetCustomVerifyEmailMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomVerifyEmailMessageTextResponse.t()

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

Specs

set_custom_verify_phone_message_text(
  input :: Zitadel.Management.V1.SetCustomVerifyPhoneMessageTextRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetCustomVerifyPhoneMessageTextResponse.t()

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

Specs

set_human_initial_password(
  input :: Zitadel.Management.V1.SetHumanInitialPasswordRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetHumanInitialPasswordResponse.t()

deprecated: use SetHumanPassword

Specs

set_human_password(
  input :: Zitadel.Management.V1.SetHumanPasswordRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetHumanPasswordResponse.t()

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

Specs

set_primary_org_domain(
  input :: Zitadel.Management.V1.SetPrimaryOrgDomainRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetPrimaryOrgDomainResponse.t()

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

Specs

set_trigger_actions(
  input :: Zitadel.Management.V1.SetTriggerActionsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetTriggerActionsResponse.t()

Specs

set_user_metadata(
  input :: Zitadel.Management.V1.SetUserMetadataRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.SetUserMetadataResponse.t()

Sets a user metadata by key

Specs

unlock_user(
  input :: Zitadel.Management.V1.UnlockUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UnlockUserResponse.t()

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

Specs

update_action(
  input :: Zitadel.Management.V1.UpdateActionRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateActionResponse.t()

Specs

update_api_app_config(
  input :: Zitadel.Management.V1.UpdateAPIAppConfigRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateAPIAppConfigResponse.t()

Changes the configuration of the api application

Specs

update_app(
  input :: Zitadel.Management.V1.UpdateAppRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateAppResponse.t()

Changes application

Specs

update_custom_label_policy(
  input :: Zitadel.Management.V1.UpdateCustomLabelPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomLabelPolicyResponse.t()

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

Specs

update_custom_lockout_policy(
  input :: Zitadel.Management.V1.UpdateCustomLockoutPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomLockoutPolicyResponse.t()

Specs

update_custom_login_policy(
  input :: Zitadel.Management.V1.UpdateCustomLoginPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomLoginPolicyResponse.t()

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

Specs

update_custom_password_age_policy(
  input :: Zitadel.Management.V1.UpdateCustomPasswordAgePolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomPasswordAgePolicyResponse.t()

The password age policy is not used at the moment

Specs

update_custom_password_complexity_policy(
  input ::
    Zitadel.Management.V1.UpdateCustomPasswordComplexityPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomPasswordComplexityPolicyResponse.t()

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

Specs

update_custom_privacy_policy(
  input :: Zitadel.Management.V1.UpdateCustomPrivacyPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateCustomPrivacyPolicyResponse.t()

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

Specs

update_human_email(
  input :: Zitadel.Management.V1.UpdateHumanEmailRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateHumanEmailResponse.t()

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

Specs

update_human_phone(
  input :: Zitadel.Management.V1.UpdateHumanPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateHumanPhoneResponse.t()

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

Specs

update_human_profile(
  input :: Zitadel.Management.V1.UpdateHumanProfileRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateHumanProfileResponse.t()

Changes the profile of the human

Specs

update_machine(
  input :: Zitadel.Management.V1.UpdateMachineRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateMachineResponse.t()

Changes a machine user

Specs

update_oidc_app_config(
  input :: Zitadel.Management.V1.UpdateOIDCAppConfigRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOIDCAppConfigResponse.t()

Changes the configuration of the oidc client

Specs

update_org(
  input :: Zitadel.Management.V1.UpdateOrgRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOrgResponse.t()

Changes my organisation

Specs

update_org_idp(
  input :: Zitadel.Management.V1.UpdateOrgIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOrgIDPResponse.t()

Change identity provider configuration of the organisation

Specs

update_org_idpjwt_config(
  input :: Zitadel.Management.V1.UpdateOrgIDPJWTConfigRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOrgIDPJWTConfigResponse.t()

Change JWT identity provider configuration of the organisation

Specs

update_org_idpoidc_config(
  input :: Zitadel.Management.V1.UpdateOrgIDPOIDCConfigRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOrgIDPOIDCConfigResponse.t()

Change OIDC identity provider configuration of the organisation

Specs

update_org_member(
  input :: Zitadel.Management.V1.UpdateOrgMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateOrgMemberResponse.t()

Changes the organisation manager

Specs

update_project(
  input :: Zitadel.Management.V1.UpdateProjectRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateProjectResponse.t()

Changes a project

Specs

update_project_grant(
  input :: Zitadel.Management.V1.UpdateProjectGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateProjectGrantResponse.t()

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

Specs

update_project_grant_member(
  input :: Zitadel.Management.V1.UpdateProjectGrantMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateProjectGrantMemberResponse.t()

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

Specs

update_project_member(
  input :: Zitadel.Management.V1.UpdateProjectMemberRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateProjectMemberResponse.t()

Change project manager, which is allowed to administrate in ZITADEL

Specs

update_project_role(
  input :: Zitadel.Management.V1.UpdateProjectRoleRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateProjectRoleResponse.t()

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

Specs

update_user_grant(
  input :: Zitadel.Management.V1.UpdateUserGrantRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateUserGrantResponse.t()

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

Specs

update_user_name(
  input :: Zitadel.Management.V1.UpdateUserNameRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.UpdateUserNameResponse.t()

Changes the username

Specs

validate_org_domain(
  input :: Zitadel.Management.V1.ValidateOrgDomainRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Management.V1.ValidateOrgDomainResponse.t()

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