org.keycloak.authentication.authenticators.resetcred.ResetOTP クラス

org.keycloak.authentication.authenticators.resetcred.ResetOTP の継承関係図

org.keycloak.authentication.authenticators.resetcred.ResetOTP 連携図

公開メンバ関数
void	authenticate (AuthenticationFlowContext context)
String	getDisplayType ()
String	getHelpText ()
String	getId ()
void	action (AuthenticationFlowContext context)
boolean	requiresUser ()
void	setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user)
String	getReferenceCategory ()
boolean	isConfigurable ()
AuthenticationExecutionModel.Requirement []	getRequirementChoices ()
boolean	isUserSetupAllowed ()
List< ProviderConfigProperty >	getConfigProperties ()
void	close ()
Authenticator	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
boolean	configuredFor (KeycloakSession session, RealmModel realm, UserModel user)

静的公開変数類
static final String	PROVIDER_ID = "reset-otp"
static final AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES

限定公開メンバ関数
boolean	configuredFor (AuthenticationFlowContext context)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

action()

void org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.action ( AuthenticationFlowContext  context )

inlineinherited

                                                          {

    }

authenticate()

void org.keycloak.authentication.authenticators.resetcred.ResetOTP.authenticate ( AuthenticationFlowContext  context )

inline

                                                                {
        if (context.getExecution().isRequired() ||
                (context.getExecution().isOptional() &&
                        configuredFor(context))) {
            context.getAuthenticationSession().addRequiredAction(UserModel.RequiredAction.CONFIGURE_TOTP);
        }
        context.success();
    }

close()

void org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.close ( )

inlineinherited

                        {

    }

configuredFor() [1/2]

boolean org.keycloak.authentication.authenticators.resetcred.ResetOTP.configuredFor ( AuthenticationFlowContext  context )

inlineprotected

                                                                       {
        return context.getSession().userCredentialManager().isConfiguredFor(context.getRealm(), context.getUser(), context.getRealm().getOTPPolicy().getType());
    }

configuredFor() [2/2]

boolean org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.configuredFor ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inlineinherited

                                                                                            {
        return true;
    }

create()

Authenticator org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.create ( KeycloakSession  session )

inlineinherited

                                                         {
        return this;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.getConfigProperties ( )

inlineinherited

                                                              {
        return null;
    }

getDisplayType()

String org.keycloak.authentication.authenticators.resetcred.ResetOTP.getDisplayType ( )

inline

                                   {
        return "Reset OTP";
    }

getHelpText()

String org.keycloak.authentication.authenticators.resetcred.ResetOTP.getHelpText ( )

inline

                                {
        return "Sets the Configure OTP required action if execution is REQUIRED.  Will also set it if execution is OPTIONAL and the OTP is currently configured for it.";
    }

getId()

String org.keycloak.authentication.authenticators.resetcred.ResetOTP.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

String org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.getReferenceCategory ( )

inlineinherited

                                         {
        return null;
    }

getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.getRequirementChoices ( )

inlineinherited

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

void org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.init ( Config.Scope  config )

inlineinherited

                                          {

    }

isConfigurable()

boolean org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.isConfigurable ( )

inlineinherited

                                    {
        return false;
    }

isUserSetupAllowed()

boolean org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.isUserSetupAllowed ( )

inlineinherited

                                        {
        return false;
    }

postInit()

void org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.postInit ( KeycloakSessionFactory  factory )

inlineinherited

                                                         {

    }

requiresUser()

boolean org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.requiresUser ( )

inlineinherited

                                  {
        return true;
    }

setRequiredActions()

void org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.setRequiredActions ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inlineinherited

                                                                                              {

    }

メンバ詳解

PROVIDER_ID

final String org.keycloak.authentication.authenticators.resetcred.ResetOTP.PROVIDER_ID = "reset-otp"

static

REQUIREMENT_CHOICES

final AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator.REQUIREMENT_CHOICES

staticinherited

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED,
            AuthenticationExecutionModel.Requirement.OPTIONAL,
            AuthenticationExecutionModel.Requirement.DISABLED

    }

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/authenticators/resetcred/ResetOTP.java