Zitadel.Management.V1.ManagementService.Behaviour behaviour (zitadel_api v1.0.0-rc.5) View Source

Link to this section Summary

Callbacks

Activates all changes of the label policy

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

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

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

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

The password age policy is not used at the moment

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

The password lockout policy is not used at the moment

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

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

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

Create a user of the type machine

Adds a new multi factor to the custom login policy

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

Creates a new organisation

Adds a new domain to my organisation

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

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

Adds an new project to the organisation

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

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

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

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

Adds a new second factor to the custom login policy

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

add a list of project roles in one request

remove a list of user grants in one request

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

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

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

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

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

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

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

Generates a new file to validate you domain

Returns an application (oidc or api)

Returns an application key

Returns the custom text for domain claimed message

Returns the custom text for initial message

Returns the custom text for password reset message

Returns the custom text for verify email message

Returns the custom text for verify email message

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

Returns the default login policy configured in the IAM

The password age policy is not used at the moment

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

The password lockout policy is not used at the moment

returns a project my organisation got granted from another organisation

GetHumanEmail returns the email and verified state of the human

Returns the phone and verified state of the human phone

Returns the profile of the human

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

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

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

Returns a machine key of a (machine) user

Returns the org given in the header

Search a org over all organisations Domain must match exactly

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

Returns a identity provider configuration of the organisation

The password age policy is not used at the moment

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

The password lockout policy is not used at the moment

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

Returns a project from my organisation (no granted projects)

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

Returns the requested full blown user (human or machine)

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

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

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

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

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

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

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

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

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

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

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

Returns all configured passwordless authentications

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

Returns all configured multi factors of the custom login policy

Returns all configured second factors of the custom login policy

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

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

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

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

Returns all ZITADEL roles which are for organisation managers

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

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

Returns all ZITADEL roles which are for project grant managers

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

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

Returns all ZITADEL roles which are for project managers

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

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

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

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

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

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

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

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

Set the state to active Returns an error if not deactivated

Sets the state of my organisation to active

Activate identity provider configuration Returns error if not deactivated

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

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

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

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

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

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

Removed the application

Removes an app key

Removes the font of the label policy

Removes the icon of the label policy

Removes the logo dark of the label policy

Removes the logo of the label policy

Removes the logo dark of the label policy

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

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

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

Removed a configured passwordless authentication

Removes the phone number of the human

Remove a identity provider from the custom login policy

Removed a machine key

Remove a multi factor from the custom login policy

Removes the avatar number of the human

Removed the domain from my organisation

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

Removes an organisation manager

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

Removes project grant and all user grants for this project grant

Removed project grant manager

Remove project manager, which is allowed to administrate in ZITADEL

Removes role from UserGrants, ProjectGrants and from Project

Remove a second factor from the custom login policy

Changes the user state to deleted

Removes a user grant

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

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

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

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

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

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

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

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

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

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

The password age policy is not used at the moment

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

The password lockout policy is not used at the moment

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

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}}

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}}

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}}

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}}

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}}

deprecated: use SetHumanPassword

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

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

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

Changes the configuration of the api application

Changes application

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

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

The password age policy is not used at the moment

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

The password lockout policy is not used at the moment

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

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

Changes the profile of the human

Changes a machine user

Changes the configuration of the oidc client

Changes my organisation

Change identity provider configuration of the organisation

Change OIDC identity provider configuration of the organisation

Changes the organisation manager

Changes a project

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

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

Change project manager, which is allowed to administrate in ZITADEL

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

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

Changes the username

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

Link to this section Callbacks

Link to this callback

activate_custom_label_policy(input, stream)

View Source (optional)

Specs

Activates all changes of the label policy

Link to this callback

add_api_app(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_app_key(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_custom_label_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_custom_login_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_custom_password_age_policy(input, stream)

View Source (optional)

Specs

The password age policy is not used at the moment

Link to this callback

add_custom_password_complexity_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_custom_password_lockout_policy(input, stream)

View Source (optional)

Specs

The password lockout policy is not used at the moment

Link to this callback

add_human_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_idp_to_login_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_machine_key(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_machine_user(input, stream)

View Source (optional)

Specs

Create a user of the type machine

Link to this callback

add_multi_factor_to_login_policy(input, stream)

View Source (optional)

Specs

Adds a new multi factor to the custom login policy

Link to this callback

add_oidc_app(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_org(input, stream)

View Source (optional)

Specs

Creates a new organisation

Link to this callback

add_org_domain(input, stream)

View Source (optional)

Specs

Adds a new domain to my organisation

Link to this callback

add_org_member(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_org_oidcidp(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_project(input, stream)

View Source (optional)

Specs

Adds an new project to the organisation

Link to this callback

add_project_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_project_grant_member(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_project_member(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_project_role(input, stream)

View Source (optional)

Specs

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

Link to this callback

add_second_factor_to_login_policy(input, stream)

View Source (optional)

Specs

Adds a new second factor to the custom login policy

Link to this callback

add_user_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

bulk_add_project_roles(input, stream)

View Source (optional)

Specs

add a list of project roles in one request

Link to this callback

bulk_remove_user_grant(input, stream)

View Source (optional)

Specs

remove a list of user grants in one request

Link to this callback

deactivate_app(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_org(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_org_idp(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_project(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_project_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

deactivate_user_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

generate_org_domain_validation(input, stream)

View Source (optional)

Specs

Generates a new file to validate you domain

Link to this callback

get_app_by_id(input, stream)

View Source (optional)

Specs

Returns an application (oidc or api)

Link to this callback

get_app_key(input, stream)

View Source (optional)

Specs

Returns an application key

Link to this callback

get_custom_domain_claimed_message_text(input, stream)

View Source (optional)

Specs

Returns the custom text for domain claimed message

Link to this callback

get_custom_init_message_text(input, stream)

View Source (optional)

Specs

Returns the custom text for initial message

Link to this callback

get_custom_password_reset_message_text(input, stream)

View Source (optional)

Specs

Returns the custom text for password reset message

Link to this callback

get_custom_verify_email_message_text(input, stream)

View Source (optional)

Specs

Returns the custom text for verify email message

Link to this callback

get_custom_verify_phone_message_text(input, stream)

View Source (optional)

Specs

Returns the custom text for verify email message

Link to this callback

get_default_label_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_default_login_policy(input, stream)

View Source (optional)

Specs

Returns the default login policy configured in the IAM

Link to this callback

get_default_password_age_policy(input, stream)

View Source (optional)

Specs

The password age policy is not used at the moment

Link to this callback

get_default_password_complexity_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_default_password_lockout_policy(input, stream)

View Source (optional)

Specs

The password lockout policy is not used at the moment

Link to this callback

get_features(input, stream)

View Source (optional)

Specs

Link to this callback

get_granted_project_by_id(input, stream)

View Source (optional)

Specs

returns a project my organisation got granted from another organisation

Link to this callback

get_human_email(input, stream)

View Source (optional)

Specs

GetHumanEmail returns the email and verified state of the human

Link to this callback

get_human_phone(input, stream)

View Source (optional)

Specs

Returns the phone and verified state of the human phone

Link to this callback

get_human_profile(input, stream)

View Source (optional)

Specs

Returns the profile of the human

Link to this callback

get_iam(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_label_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_login_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_machine_key_by_i_ds(input, stream)

View Source (optional)

Specs

Returns a machine key of a (machine) user

Link to this callback

get_my_org(input, stream)

View Source (optional)

Specs

Returns the org given in the header

Link to this callback

get_oidc_information(input, stream)

View Source (optional)

Specs

Link to this callback

get_org_by_domain_global(input, stream)

View Source (optional)

Specs

Search a org over all organisations Domain must match exactly

Link to this callback

get_org_iam_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_org_idp_by_id(input, stream)

View Source (optional)

Specs

Returns a identity provider configuration of the organisation

Link to this callback

get_password_age_policy(input, stream)

View Source (optional)

Specs

The password age policy is not used at the moment

Link to this callback

get_password_complexity_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_password_lockout_policy(input, stream)

View Source (optional)

Specs

The password lockout policy is not used at the moment

Link to this callback

get_preview_label_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_project_by_id(input, stream)

View Source (optional)

Specs

Returns a project from my organisation (no granted projects)

Link to this callback

get_project_grant_by_id(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_user_by_id(input, stream)

View Source (optional)

Specs

Returns the requested full blown user (human or machine)

Link to this callback

get_user_by_login_name_global(input, stream)

View Source (optional)

Specs

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

Link to this callback

get_user_grant_by_id(input, stream)

View Source (optional)

Specs

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

Link to this callback

healthz(input, stream)

View Source (optional)

Specs

Link to this callback

import_human_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

is_user_unique(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_app_changes(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_app_keys(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_apps(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_granted_project_roles(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_granted_projects(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_human_auth_factors(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_human_linked_id_ps(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_human_passwordless(input, stream)

View Source (optional)

Specs

Returns all configured passwordless authentications

Link to this callback

list_login_policy_id_ps(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_login_policy_multi_factors(input, stream)

View Source (optional)

Specs

Returns all configured multi factors of the custom login policy

Link to this callback

list_login_policy_second_factors(input, stream)

View Source (optional)

Specs

Returns all configured second factors of the custom login policy

Link to this callback

list_machine_keys(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_org_changes(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_org_domains(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_org_id_ps(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_org_member_roles(input, stream)

View Source (optional)

Specs

Returns all ZITADEL roles which are for organisation managers

Link to this callback

list_org_members(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_project_changes(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_project_grant_member_roles(input, stream)

View Source (optional)

Specs

Returns all ZITADEL roles which are for project grant managers

Link to this callback

list_project_grant_members(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_project_grants(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_project_member_roles(input, stream)

View Source (optional)

Specs

Returns all ZITADEL roles which are for project managers

Link to this callback

list_project_members(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_project_roles(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_projects(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_user_changes(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_user_grants(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_user_memberships(input, stream)

View Source (optional)

Specs

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

Link to this callback

list_users(input, stream)

View Source (optional)

Specs

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

Link to this callback

lock_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

reactivate_app(input, stream)

View Source (optional)

Specs

Set the state to active Returns an error if not deactivated

Link to this callback

reactivate_org(input, stream)

View Source (optional)

Specs

Sets the state of my organisation to active

Link to this callback

reactivate_org_idp(input, stream)

View Source (optional)

Specs

Activate identity provider configuration Returns error if not deactivated

Link to this callback

reactivate_project(input, stream)

View Source (optional)

Specs

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

Link to this callback

reactivate_project_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

reactivate_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

reactivate_user_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

regenerate_api_client_secret(input, stream)

View Source (optional)

Specs

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

Link to this callback

regenerate_oidc_client_secret(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_app(input, stream)

View Source (optional)

Specs

Removed the application

Link to this callback

remove_app_key(input, stream)

View Source (optional)

Specs

Removes an app key

Link to this callback

remove_custom_label_policy_font(input, stream)

View Source (optional)

Specs

Removes the font of the label policy

Link to this callback

remove_custom_label_policy_icon(input, stream)

View Source (optional)

Specs

Removes the icon of the label policy

Link to this callback

remove_custom_label_policy_icon_dark(input, stream)

View Source (optional)

Specs

Removes the logo dark of the label policy

Link to this callback

remove_custom_label_policy_logo(input, stream)

View Source (optional)

Specs

Removes the logo of the label policy

Link to this callback

remove_custom_label_policy_logo_dark(input, stream)

View Source (optional)

Specs

Removes the logo dark of the label policy

Link to this callback

remove_human_auth_factor_otp(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_human_auth_factor_u2_f(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_human_linked_idp(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_human_passwordless(input, stream)

View Source (optional)

Specs

Removed a configured passwordless authentication

Link to this callback

remove_human_phone(input, stream)

View Source (optional)

Specs

Removes the phone number of the human

Link to this callback

remove_idp_from_login_policy(input, stream)

View Source (optional)

Specs

Remove a identity provider from the custom login policy

Link to this callback

remove_machine_key(input, stream)

View Source (optional)

Specs

Removed a machine key

Link to this callback

remove_multi_factor_from_login_policy(input, stream)

View Source (optional)

Specs

Remove a multi factor from the custom login policy

Link to this callback

remove_my_avatar(input, stream)

View Source (optional)

Specs

Removes the avatar number of the human

Link to this callback

remove_org_domain(input, stream)

View Source (optional)

Specs

Removed the domain from my organisation

Link to this callback

remove_org_idp(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_org_member(input, stream)

View Source (optional)

Specs

Removes an organisation manager

Link to this callback

remove_project(input, stream)

View Source (optional)

Specs

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

Link to this callback

remove_project_grant(input, stream)

View Source (optional)

Specs

Removes project grant and all user grants for this project grant

Link to this callback

remove_project_grant_member(input, stream)

View Source (optional)

Specs

Removed project grant manager

Link to this callback

remove_project_member(input, stream)

View Source (optional)

Specs

Remove project manager, which is allowed to administrate in ZITADEL

Link to this callback

remove_project_role(input, stream)

View Source (optional)

Specs

Removes role from UserGrants, ProjectGrants and from Project

Link to this callback

remove_second_factor_from_login_policy(input, stream)

View Source (optional)

Specs

Remove a second factor from the custom login policy

Link to this callback

remove_user(input, stream)

View Source (optional)

Specs

Changes the user state to deleted

Link to this callback

remove_user_grant(input, stream)

View Source (optional)

Specs

Removes a user grant

Link to this callback

resend_human_email_verification(input, stream)

View Source (optional)

Specs

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

Link to this callback

resend_human_initialization(input, stream)

View Source (optional)

Specs

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

Link to this callback

resend_human_phone_verification(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_custom_domain_claimed_message_text_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_custom_init_message_text_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_custom_password_reset_message_text_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_custom_verify_email_message_text_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_custom_verify_phone_message_text_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_label_policy_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_login_policy_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_password_age_policy_to_default(input, stream)

View Source (optional)

Specs

The password age policy is not used at the moment

Link to this callback

reset_password_complexity_policy_to_default(input, stream)

View Source (optional)

Specs

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

Link to this callback

reset_password_lockout_policy_to_default(input, stream)

View Source (optional)

Specs

The password lockout policy is not used at the moment

Link to this callback

send_human_reset_password_notification(input, stream)

View Source (optional)

Specs

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

Link to this callback

set_custom_domain_claimed_message_custom_text(input, stream)

View Source (optional)

Specs

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}}

Link to this callback

set_custom_init_message_text(input, stream)

View Source (optional)

Specs

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}}

Link to this callback

set_custom_password_reset_message_text(input, stream)

View Source (optional)

Specs

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}}

Link to this callback

set_custom_verify_email_message_text(input, stream)

View Source (optional)

Specs

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}}

Link to this callback

set_custom_verify_phone_message_text(input, stream)

View Source (optional)

Specs

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}}

Link to this callback

set_human_initial_password(input, stream)

View Source (optional)

Specs

deprecated: use SetHumanPassword

Link to this callback

set_human_password(input, stream)

View Source (optional)

Specs

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

Link to this callback

set_primary_org_domain(input, stream)

View Source (optional)

Specs

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

Link to this callback

unlock_user(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_api_app_config(input, stream)

View Source (optional)

Specs

Changes the configuration of the api application

Link to this callback

update_app(input, stream)

View Source (optional)

Specs

Changes application

Link to this callback

update_custom_label_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_custom_login_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_custom_password_age_policy(input, stream)

View Source (optional)

Specs

The password age policy is not used at the moment

Link to this callback

update_custom_password_complexity_policy(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_custom_password_lockout_policy(input, stream)

View Source (optional)

Specs

The password lockout policy is not used at the moment

Link to this callback

update_human_email(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_human_phone(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_human_profile(input, stream)

View Source (optional)

Specs

Changes the profile of the human

Link to this callback

update_machine(input, stream)

View Source (optional)

Specs

Changes a machine user

Link to this callback

update_oidc_app_config(input, stream)

View Source (optional)

Specs

Changes the configuration of the oidc client

Link to this callback

update_org(input, stream)

View Source (optional)

Specs

Changes my organisation

Link to this callback

update_org_idp(input, stream)

View Source (optional)

Specs

Change identity provider configuration of the organisation

Link to this callback

update_org_idpoidc_config(input, stream)

View Source (optional)

Specs

Change OIDC identity provider configuration of the organisation

Link to this callback

update_org_member(input, stream)

View Source (optional)

Specs

Changes the organisation manager

Link to this callback

update_project(input, stream)

View Source (optional)

Specs

Changes a project

Link to this callback

update_project_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_project_grant_member(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_project_member(input, stream)

View Source (optional)

Specs

Change project manager, which is allowed to administrate in ZITADEL

Link to this callback

update_project_role(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_user_grant(input, stream)

View Source (optional)

Specs

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

Link to this callback

update_user_name(input, stream)

View Source (optional)

Specs

Changes the username

Link to this callback

validate_org_domain(input, stream)

View Source (optional)

Specs

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