Zitadel.Admin.V1.AdminService.Behaviour behaviour (zitadel_api v1.0.0-rc.4) View Source
Link to this section Summary
Callbacks
Defines a custom ORGIAM policy as specified
Adds a user to the membership list of ZITADEL with the given roles undefined roles will be dropped
Adds the povided idp to the default login policy. It impacts all organisations without a customised policy
Adds a multi factor to the default login policy. It impacts all organisations without a customised policy
Adds a new oidc identity provider configuration the IAM
Adds a second factor to the default login policy. It impacts all organisations without a customised policy
Truncates the delta of the change stream be carefull with this function because ZITADEL has to recompute the deltas after they got cleared. Search requests will return wrong results until all deltas are recomputed
Sets the state of the idp to IDP_STATE_INACTIVE the state MUST be IDP_STATE_ACTIVE for this call
Returns the customised policy or the default if not customised
Returns a identity provider configuration of the IAM
Returns the label policy defined by the administrators of ZITADEL
Returns the login policy defined by the administrators of ZITADEL
Returns an organisation by id
Returns the IAM policy defined by the administrators of ZITADEL
Returns the password age policy defined by the administrators of ZITADEL
Returns the password complexity policy defined by the administrators of ZITADEL
Returns the password lockout policy defined by the administrators of ZITADEL
Indicates if ZITADEL is running. It respondes as soon as ZITADEL started
Checks whether an organisation exists by the given parameters
Returns event descriptions which cannot be processed. It's possible that some events need some retries. For example if the SMTP-API wasn't able to send an email at the first time
Returns the IAM roles visible for the requested user
Returns all members matching the request all queries need to match (ANDed)
Returns all identity provider configurations of the IAM
Returns the idps linked to the default login policy, defined by the administrators of ZITADEL
Returns the available multi factors defined by the administrators of ZITADEL
Returns the available second factors defined by the administrators of ZITADEL
Returns all organisations matching the request all queries need to match (AND)
Returns all stored read models of ZITADEL views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects
Sets the state of the idp to IDP_STATE_ACTIVE the state MUST be IDP_STATE_INACTIVE for this call
Deletes the event from failed events view.
the event is not removed from the change stream
This call is usefull if the system was able to process the event later.
e.g. if the second try of sending an email was successful. the first try produced a
failed event. You can find out if it worked on the failure_count
Removes the user from the membership list of ZITADEL
RemoveIDP deletes the IDP permanetly
Removes the povided idp from the default login policy. It impacts all organisations without a customised policy
Removes a multi factor from the default login policy. It impacts all organisations without a customised policy
Removes a second factor from the default login policy. It impacts all organisations without a customised policy
Resets the org iam policy of the organisation to default ZITADEL will fallback to the default policy defined by the ZITADEL administrators
Creates a new org and user and adds the user to the orgs members as ORG_OWNER
Updates a custom ORGIAM policy as specified
Sets the given roles on a member. The member has only roles provided by this call
Updates the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
Updates the oidc configuration of the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
Updates the default label policy of ZITADEL it impacts all organisations without a customised policy
Updates the default login policy of ZITADEL it impacts all organisations without a customised policy
Updates the default IAM policy. it impacts all organisations without a customised policy
Updates the default password age policy of ZITADEL it impacts all organisations without a customised policy
Updates the default password complexity policy of ZITADEL it impacts all organisations without a customised policy
Updates the default password lockout policy of ZITADEL it impacts all organisations without a customised policy
Link to this section Callbacks
Specs
add_custom_org_iam_policy( input :: Zitadel.Admin.V1.AddCustomOrgIAMPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddCustomOrgIAMPolicyResponse.t()
Defines a custom ORGIAM policy as specified
Specs
add_iam_member( input :: Zitadel.Admin.V1.AddIAMMemberRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddIAMMemberResponse.t()
Adds a user to the membership list of ZITADEL with the given roles undefined roles will be dropped
Specs
add_idp_to_login_policy( input :: Zitadel.Admin.V1.AddIDPToLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddIDPToLoginPolicyResponse.t()
Adds the povided idp to the default login policy. It impacts all organisations without a customised policy
Specs
add_multi_factor_to_login_policy( input :: Zitadel.Admin.V1.AddMultiFactorToLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddMultiFactorToLoginPolicyResponse.t()
Adds a multi factor to the default login policy. It impacts all organisations without a customised policy
Specs
add_oidcidp( input :: Zitadel.Admin.V1.AddOIDCIDPRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddOIDCIDPResponse.t()
Adds a new oidc identity provider configuration the IAM
Specs
add_second_factor_to_login_policy( input :: Zitadel.Admin.V1.AddSecondFactorToLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.AddSecondFactorToLoginPolicyResponse.t()
Adds a second factor to the default login policy. It impacts all organisations without a customised policy
Specs
clear_view( input :: Zitadel.Admin.V1.ClearViewRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ClearViewResponse.t()
Truncates the delta of the change stream be carefull with this function because ZITADEL has to recompute the deltas after they got cleared. Search requests will return wrong results until all deltas are recomputed
Specs
deactivate_idp( input :: Zitadel.Admin.V1.DeactivateIDPRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.DeactivateIDPResponse.t()
Sets the state of the idp to IDP_STATE_INACTIVE the state MUST be IDP_STATE_ACTIVE for this call
Specs
get_custom_org_iam_policy( input :: Zitadel.Admin.V1.GetCustomOrgIAMPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetCustomOrgIAMPolicyResponse.t()
Returns the customised policy or the default if not customised
Specs
get_default_features( input :: Zitadel.Admin.V1.GetDefaultFeaturesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetDefaultFeaturesResponse.t()
Specs
get_idp_by_id( input :: Zitadel.Admin.V1.GetIDPByIDRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetIDPByIDResponse.t()
Returns a identity provider configuration of the IAM
Specs
get_label_policy( input :: Zitadel.Admin.V1.GetLabelPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetLabelPolicyResponse.t()
Returns the label policy defined by the administrators of ZITADEL
Specs
get_login_policy( input :: Zitadel.Admin.V1.GetLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetLoginPolicyResponse.t()
Returns the login policy defined by the administrators of ZITADEL
Specs
get_org_by_id( input :: Zitadel.Admin.V1.GetOrgByIDRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetOrgByIDResponse.t()
Returns an organisation by id
Specs
get_org_features( input :: Zitadel.Admin.V1.GetOrgFeaturesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetOrgFeaturesResponse.t()
Specs
get_org_iam_policy( input :: Zitadel.Admin.V1.GetOrgIAMPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetOrgIAMPolicyResponse.t()
Returns the IAM policy defined by the administrators of ZITADEL
Specs
get_password_age_policy( input :: Zitadel.Admin.V1.GetPasswordAgePolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetPasswordAgePolicyResponse.t()
Returns the password age policy defined by the administrators of ZITADEL
Specs
get_password_complexity_policy( input :: Zitadel.Admin.V1.GetPasswordComplexityPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetPasswordComplexityPolicyResponse.t()
Returns the password complexity policy defined by the administrators of ZITADEL
Specs
get_password_lockout_policy( input :: Zitadel.Admin.V1.GetPasswordLockoutPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.GetPasswordLockoutPolicyResponse.t()
Returns the password lockout policy defined by the administrators of ZITADEL
Specs
healthz( input :: Zitadel.Admin.V1.HealthzRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.HealthzResponse.t()
Indicates if ZITADEL is running. It respondes as soon as ZITADEL started
Specs
is_org_unique( input :: Zitadel.Admin.V1.IsOrgUniqueRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.IsOrgUniqueResponse.t()
Checks whether an organisation exists by the given parameters
Specs
list_failed_events( input :: Zitadel.Admin.V1.ListFailedEventsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListFailedEventsResponse.t()
Returns event descriptions which cannot be processed. It's possible that some events need some retries. For example if the SMTP-API wasn't able to send an email at the first time
Specs
list_iam_member_roles( input :: Zitadel.Admin.V1.ListIAMMemberRolesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListIAMMemberRolesResponse.t()
Returns the IAM roles visible for the requested user
Specs
list_iam_members( input :: Zitadel.Admin.V1.ListIAMMembersRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListIAMMembersResponse.t()
Returns all members matching the request all queries need to match (ANDed)
Specs
list_id_ps( input :: Zitadel.Admin.V1.ListIDPsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListIDPsResponse.t()
Returns all identity provider configurations of the IAM
Specs
list_login_policy_id_ps( input :: Zitadel.Admin.V1.ListLoginPolicyIDPsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListLoginPolicyIDPsResponse.t()
Returns the idps linked to the default login policy, defined by the administrators of ZITADEL
Specs
list_login_policy_multi_factors( input :: Zitadel.Admin.V1.ListLoginPolicyMultiFactorsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListLoginPolicyMultiFactorsResponse.t()
Returns the available multi factors defined by the administrators of ZITADEL
Specs
list_login_policy_second_factors( input :: Zitadel.Admin.V1.ListLoginPolicySecondFactorsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListLoginPolicySecondFactorsResponse.t()
Returns the available second factors defined by the administrators of ZITADEL
Specs
list_orgs( input :: Zitadel.Admin.V1.ListOrgsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListOrgsResponse.t()
Returns all organisations matching the request all queries need to match (AND)
Specs
list_views( input :: Zitadel.Admin.V1.ListViewsRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ListViewsResponse.t()
Returns all stored read models of ZITADEL views are used for search optimisation and optimise request latencies they represent the delta of the event happend on the objects
Specs
reactivate_idp( input :: Zitadel.Admin.V1.ReactivateIDPRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ReactivateIDPResponse.t()
Sets the state of the idp to IDP_STATE_ACTIVE the state MUST be IDP_STATE_INACTIVE for this call
Specs
remove_failed_event( input :: Zitadel.Admin.V1.RemoveFailedEventRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveFailedEventResponse.t()
Deletes the event from failed events view.
the event is not removed from the change stream
This call is usefull if the system was able to process the event later.
e.g. if the second try of sending an email was successful. the first try produced a
failed event. You can find out if it worked on the failure_count
Specs
remove_iam_member( input :: Zitadel.Admin.V1.RemoveIAMMemberRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveIAMMemberResponse.t()
Removes the user from the membership list of ZITADEL
Specs
remove_idp( input :: Zitadel.Admin.V1.RemoveIDPRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveIDPResponse.t()
RemoveIDP deletes the IDP permanetly
Specs
remove_idp_from_login_policy( input :: Zitadel.Admin.V1.RemoveIDPFromLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveIDPFromLoginPolicyResponse.t()
Removes the povided idp from the default login policy. It impacts all organisations without a customised policy
Specs
remove_multi_factor_from_login_policy( input :: Zitadel.Admin.V1.RemoveMultiFactorFromLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveMultiFactorFromLoginPolicyResponse.t()
Removes a multi factor from the default login policy. It impacts all organisations without a customised policy
Specs
remove_second_factor_from_login_policy( input :: Zitadel.Admin.V1.RemoveSecondFactorFromLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.RemoveSecondFactorFromLoginPolicyResponse.t()
Removes a second factor from the default login policy. It impacts all organisations without a customised policy
Specs
reset_custom_org_iam_policy_to_default( input :: Zitadel.Admin.V1.ResetCustomOrgIAMPolicyToDefaultRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ResetCustomOrgIAMPolicyToDefaultResponse.t()
Resets the org iam policy of the organisation to default ZITADEL will fallback to the default policy defined by the ZITADEL administrators
Specs
reset_org_features( input :: Zitadel.Admin.V1.ResetOrgFeaturesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.ResetOrgFeaturesResponse.t()
Specs
set_default_features( input :: Zitadel.Admin.V1.SetDefaultFeaturesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.SetDefaultFeaturesResponse.t()
Specs
set_org_features( input :: Zitadel.Admin.V1.SetOrgFeaturesRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.SetOrgFeaturesResponse.t()
Specs
set_up_org( input :: Zitadel.Admin.V1.SetUpOrgRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.SetUpOrgResponse.t()
Creates a new org and user and adds the user to the orgs members as ORG_OWNER
Specs
update_custom_org_iam_policy( input :: Zitadel.Admin.V1.UpdateCustomOrgIAMPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateCustomOrgIAMPolicyResponse.t()
Updates a custom ORGIAM policy as specified
Specs
update_iam_member( input :: Zitadel.Admin.V1.UpdateIAMMemberRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateIAMMemberResponse.t()
Sets the given roles on a member. The member has only roles provided by this call
Specs
update_idp( input :: Zitadel.Admin.V1.UpdateIDPRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateIDPResponse.t()
Updates the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
Specs
update_idpoidc_config( input :: Zitadel.Admin.V1.UpdateIDPOIDCConfigRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateIDPOIDCConfigResponse.t()
Updates the oidc configuration of the specified idp all fields are updated. If no value is provided the field will be empty afterwards.
Specs
update_label_policy( input :: Zitadel.Admin.V1.UpdateLabelPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateLabelPolicyResponse.t()
Updates the default label policy of ZITADEL it impacts all organisations without a customised policy
Specs
update_login_policy( input :: Zitadel.Admin.V1.UpdateLoginPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateLoginPolicyResponse.t()
Updates the default login policy of ZITADEL it impacts all organisations without a customised policy
Specs
update_org_iam_policy( input :: Zitadel.Admin.V1.UpdateOrgIAMPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdateOrgIAMPolicyResponse.t()
Updates the default IAM policy. it impacts all organisations without a customised policy
Specs
update_password_age_policy( input :: Zitadel.Admin.V1.UpdatePasswordAgePolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdatePasswordAgePolicyResponse.t()
Updates the default password age policy of ZITADEL it impacts all organisations without a customised policy
Specs
update_password_complexity_policy( input :: Zitadel.Admin.V1.UpdatePasswordComplexityPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdatePasswordComplexityPolicyResponse.t()
Updates the default password complexity policy of ZITADEL it impacts all organisations without a customised policy
Specs
update_password_lockout_policy( input :: Zitadel.Admin.V1.UpdatePasswordLockoutPolicyRequest.t(), stream :: GRPC.Server.Stream.t() ) :: Zitadel.Admin.V1.UpdatePasswordLockoutPolicyResponse.t()
Updates the default password lockout policy of ZITADEL it impacts all organisations without a customised policy