Zitadel.Auth.V1.AuthService.Behaviour behaviour (zitadel_api v1.0.0-rc.4) View Source

Link to this section Summary

Callbacks

Adds a new OTP (One Time Password) Second Factor to the authorized user Only one OTP can be configured per user

Adds a new U2F (Universal Second Factor) to the authorized user Multiple U2Fs can be configured

Adds a new passwordless authentications to the authorized user Multiple passwordless authentications can be configured

Returns the email address of the authorized user

Returns the password complexity policy of my organisation This policy defines how the password should look

Returns the phone number of the authorized user

Returns the profile information of the authorized user

Returns my full blown user

Returns all configured authentication factors (second and multi)

Returns a list of all linked identity providers (social logins, eg. Google, Microsoft, AD, etc.)

Returns all configured passwordless authentications of the authorized user

Returns a list of organisations where the authorized user has a user grant (authorization) in the context of the requested project

Returns a list of roles for the authorized user and project

Returns the history of the authorized user (each event)

Returns all user grants (authorizations) of the authorized user

Returns the user sessions of the authorized user of the current useragent

Returns a list of features, which are allowed on these organisation based on the subscription of the organisation

Returns the permissions the authorized user has in ZITADEL based on his manager roles (e.g ORG_OWNER)

Removed the configured OTP (One Time Password) Factor

Removes the U2F Authentication from the authorized user

Removes a linked identity provider (social logins, eg. Google, Microsoft, AD, etc.)

Removes the passwordless configuration from the authorized user

Removed the phone number of the authorized user

Sends a new email to the last given address to verify it

Resends a sms to the last given phone number, to verify it

Changes the email address of the authorized user An email is sent to the given address, to verify it

Sets the phone number of the authorized user An sms is sent to the number with a verification code

Change the password of the authorized user

Changes the profile information of the authorized user

Change the user name of the authorize user

Verify the last added OTP (One Time Password)

Verifies the last added U2F (Universal Second Factor) of the authorized user

Sets the email address to verified

Verifies the last added passwordless configuration

Sets the phone number to verified

Link to this section Callbacks

Link to this callback

add_my_auth_factor_otp(input, stream)

View Source (optional)

Specs

add_my_auth_factor_otp(
  input :: Zitadel.Auth.V1.AddMyAuthFactorOTPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.AddMyAuthFactorOTPResponse.t()

Adds a new OTP (One Time Password) Second Factor to the authorized user Only one OTP can be configured per user

Link to this callback

add_my_auth_factor_u2_f(input, stream)

View Source (optional)

Specs

add_my_auth_factor_u2_f(
  input :: Zitadel.Auth.V1.AddMyAuthFactorU2FRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.AddMyAuthFactorU2FResponse.t()

Adds a new U2F (Universal Second Factor) to the authorized user Multiple U2Fs can be configured

Link to this callback

add_my_passwordless(input, stream)

View Source (optional)

Specs

add_my_passwordless(
  input :: Zitadel.Auth.V1.AddMyPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.AddMyPasswordlessResponse.t()

Adds a new passwordless authentications to the authorized user Multiple passwordless authentications can be configured

Link to this callback

get_my_email(input, stream)

View Source (optional)

Specs

get_my_email(
  input :: Zitadel.Auth.V1.GetMyEmailRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.GetMyEmailResponse.t()

Returns the email address of the authorized user

Link to this callback

get_my_password_complexity_policy(input, stream)

View Source (optional)

Specs

get_my_password_complexity_policy(
  input :: Zitadel.Auth.V1.GetMyPasswordComplexityPolicyRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.GetMyPasswordComplexityPolicyResponse.t()

Returns the password complexity policy of my organisation This policy defines how the password should look

Link to this callback

get_my_phone(input, stream)

View Source (optional)

Specs

get_my_phone(
  input :: Zitadel.Auth.V1.GetMyPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.GetMyPhoneResponse.t()

Returns the phone number of the authorized user

Link to this callback

get_my_profile(input, stream)

View Source (optional)

Specs

get_my_profile(
  input :: Zitadel.Auth.V1.GetMyProfileRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.GetMyProfileResponse.t()

Returns the profile information of the authorized user

Link to this callback

get_my_user(input, stream)

View Source (optional)

Specs

get_my_user(
  input :: Zitadel.Auth.V1.GetMyUserRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.GetMyUserResponse.t()

Returns my full blown user

Link to this callback

healthz(input, stream)

View Source (optional)

Specs

Link to this callback

list_my_auth_factors(input, stream)

View Source (optional)

Specs

list_my_auth_factors(
  input :: Zitadel.Auth.V1.ListMyAuthFactorsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyAuthFactorsResponse.t()

Returns all configured authentication factors (second and multi)

Link to this callback

list_my_linked_id_ps(input, stream)

View Source (optional)

Specs

list_my_linked_id_ps(
  input :: Zitadel.Auth.V1.ListMyLinkedIDPsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyLinkedIDPsResponse.t()

Returns a list of all linked identity providers (social logins, eg. Google, Microsoft, AD, etc.)

Link to this callback

list_my_passwordless(input, stream)

View Source (optional)

Specs

list_my_passwordless(
  input :: Zitadel.Auth.V1.ListMyPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyPasswordlessResponse.t()

Returns all configured passwordless authentications of the authorized user

Link to this callback

list_my_project_orgs(input, stream)

View Source (optional)

Specs

list_my_project_orgs(
  input :: Zitadel.Auth.V1.ListMyProjectOrgsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyProjectOrgsResponse.t()

Returns a list of organisations where the authorized user has a user grant (authorization) in the context of the requested project

Link to this callback

list_my_project_permissions(input, stream)

View Source (optional)

Specs

list_my_project_permissions(
  input :: Zitadel.Auth.V1.ListMyProjectPermissionsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyProjectPermissionsResponse.t()

Returns a list of roles for the authorized user and project

Link to this callback

list_my_user_changes(input, stream)

View Source (optional)

Specs

list_my_user_changes(
  input :: Zitadel.Auth.V1.ListMyUserChangesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyUserChangesResponse.t()

Returns the history of the authorized user (each event)

Link to this callback

list_my_user_grants(input, stream)

View Source (optional)

Specs

list_my_user_grants(
  input :: Zitadel.Auth.V1.ListMyUserGrantsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyUserGrantsResponse.t()

Returns all user grants (authorizations) of the authorized user

Link to this callback

list_my_user_sessions(input, stream)

View Source (optional)

Specs

list_my_user_sessions(
  input :: Zitadel.Auth.V1.ListMyUserSessionsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyUserSessionsResponse.t()

Returns the user sessions of the authorized user of the current useragent

Link to this callback

list_my_zitadel_features(input, stream)

View Source (optional)

Specs

list_my_zitadel_features(
  input :: Zitadel.Auth.V1.ListMyZitadelFeaturesRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyZitadelFeaturesResponse.t()

Returns a list of features, which are allowed on these organisation based on the subscription of the organisation

Link to this callback

list_my_zitadel_permissions(input, stream)

View Source (optional)

Specs

list_my_zitadel_permissions(
  input :: Zitadel.Auth.V1.ListMyZitadelPermissionsRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ListMyZitadelPermissionsResponse.t()

Returns the permissions the authorized user has in ZITADEL based on his manager roles (e.g ORG_OWNER)

Link to this callback

remove_my_auth_factor_otp(input, stream)

View Source (optional)

Specs

remove_my_auth_factor_otp(
  input :: Zitadel.Auth.V1.RemoveMyAuthFactorOTPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.RemoveMyAuthFactorOTPResponse.t()

Removed the configured OTP (One Time Password) Factor

Link to this callback

remove_my_auth_factor_u2_f(input, stream)

View Source (optional)

Specs

remove_my_auth_factor_u2_f(
  input :: Zitadel.Auth.V1.RemoveMyAuthFactorU2FRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.RemoveMyAuthFactorU2FResponse.t()

Removes the U2F Authentication from the authorized user

Link to this callback

remove_my_linked_idp(input, stream)

View Source (optional)

Specs

remove_my_linked_idp(
  input :: Zitadel.Auth.V1.RemoveMyLinkedIDPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.RemoveMyLinkedIDPResponse.t()

Removes a linked identity provider (social logins, eg. Google, Microsoft, AD, etc.)

Link to this callback

remove_my_passwordless(input, stream)

View Source (optional)

Specs

remove_my_passwordless(
  input :: Zitadel.Auth.V1.RemoveMyPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.RemoveMyPasswordlessResponse.t()

Removes the passwordless configuration from the authorized user

Link to this callback

remove_my_phone(input, stream)

View Source (optional)

Specs

remove_my_phone(
  input :: Zitadel.Auth.V1.RemoveMyPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.RemoveMyPhoneResponse.t()

Removed the phone number of the authorized user

Link to this callback

resend_my_email_verification(input, stream)

View Source (optional)

Specs

resend_my_email_verification(
  input :: Zitadel.Auth.V1.ResendMyEmailVerificationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ResendMyEmailVerificationResponse.t()

Sends a new email to the last given address to verify it

Link to this callback

resend_my_phone_verification(input, stream)

View Source (optional)

Specs

resend_my_phone_verification(
  input :: Zitadel.Auth.V1.ResendMyPhoneVerificationRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.ResendMyPhoneVerificationResponse.t()

Resends a sms to the last given phone number, to verify it

Link to this callback

set_my_email(input, stream)

View Source (optional)

Specs

set_my_email(
  input :: Zitadel.Auth.V1.SetMyEmailRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.SetMyEmailResponse.t()

Changes the email address of the authorized user An email is sent to the given address, to verify it

Link to this callback

set_my_phone(input, stream)

View Source (optional)

Specs

set_my_phone(
  input :: Zitadel.Auth.V1.SetMyPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.SetMyPhoneResponse.t()

Sets the phone number of the authorized user An sms is sent to the number with a verification code

Link to this callback

update_my_password(input, stream)

View Source (optional)

Specs

update_my_password(
  input :: Zitadel.Auth.V1.UpdateMyPasswordRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.UpdateMyPasswordResponse.t()

Change the password of the authorized user

Link to this callback

update_my_profile(input, stream)

View Source (optional)

Specs

update_my_profile(
  input :: Zitadel.Auth.V1.UpdateMyProfileRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.UpdateMyProfileResponse.t()

Changes the profile information of the authorized user

Link to this callback

update_my_user_name(input, stream)

View Source (optional)

Specs

update_my_user_name(
  input :: Zitadel.Auth.V1.UpdateMyUserNameRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.UpdateMyUserNameResponse.t()

Change the user name of the authorize user

Link to this callback

verify_my_auth_factor_otp(input, stream)

View Source (optional)

Specs

verify_my_auth_factor_otp(
  input :: Zitadel.Auth.V1.VerifyMyAuthFactorOTPRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.VerifyMyAuthFactorOTPResponse.t()

Verify the last added OTP (One Time Password)

Link to this callback

verify_my_auth_factor_u2_f(input, stream)

View Source (optional)

Specs

verify_my_auth_factor_u2_f(
  input :: Zitadel.Auth.V1.VerifyMyAuthFactorU2FRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.VerifyMyAuthFactorU2FResponse.t()

Verifies the last added U2F (Universal Second Factor) of the authorized user

Link to this callback

verify_my_email(input, stream)

View Source (optional)

Specs

verify_my_email(
  input :: Zitadel.Auth.V1.VerifyMyEmailRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.VerifyMyEmailResponse.t()

Sets the email address to verified

Link to this callback

verify_my_passwordless(input, stream)

View Source (optional)

Specs

verify_my_passwordless(
  input :: Zitadel.Auth.V1.VerifyMyPasswordlessRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.VerifyMyPasswordlessResponse.t()

Verifies the last added passwordless configuration

Link to this callback

verify_my_phone(input, stream)

View Source (optional)

Specs

verify_my_phone(
  input :: Zitadel.Auth.V1.VerifyMyPhoneRequest.t(),
  stream :: GRPC.Server.Stream.t()
) :: Zitadel.Auth.V1.VerifyMyPhoneResponse.t()

Sets the phone number to verified