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

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

公開メンバ関数
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)

void	authenticate (AuthenticationFlowContext context)

String	getId ()

default int	order ()

String	getDisplayType ()

String	getHelpText ()

静的公開変数類
static final AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES

詳解

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ action()

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

inline

org.keycloak.authentication.Authenticatorを実装しています。

                                                           {
 
     }

◆ authenticate()

void org.keycloak.authentication.Authenticator.authenticate ( AuthenticationFlowContext context )

inherited

Initial call for the authenticator. This method should check the current HTTP request to determine if the request satifies the Authenticator's requirements. If it doesn't, it should send back a challenge response by calling the AuthenticationFlowContext.challenge(Response). If this challenge is a authentication, the action URL of the form must point to

/realms/{realm}/login-actions/authenticate?code={session-code}&execution={executionId}

or

/realms/{realm}/login-actions/registration?code={session-code}&execution={executionId}

{session-code} pertains to the code generated from AuthenticationFlowContext.generateAccessCode(). The {executionId} pertains to the AuthenticationExecutionModel.getId() value obtained from AuthenticationFlowContext.getExecution().

The action URL will invoke the action() method described below.

引数

context

◆ close()

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

inline

org.keycloak.provider.Providerを実装しています。

                         {
 
     }

◆ configuredFor()

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

inline

org.keycloak.authentication.Authenticatorを実装しています。

                                                                                             {
         return true;
     }

◆ create()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
         return this;
     }

◆ getConfigProperties()

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

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                                               {
         return null;
     }

◆ getDisplayType()

String org.keycloak.authentication.ConfigurableAuthenticatorFactory.getDisplayType ( )

inherited

Friendly name for the authenticator

戻り値

◆ getHelpText()

String org.keycloak.provider.ConfiguredProvider.getHelpText ( )

inherited

◆ getId()

String org.keycloak.provider.ProviderFactory< T extends Provider >.getId ( )

inherited

◆ getReferenceCategory()

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

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                          {
         return null;
     }

◆ getRequirementChoices()

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

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                                                               {
         return REQUIREMENT_CHOICES;
     }

◆ init()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                           {
 
     }

◆ isConfigurable()

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

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                     {
         return false;
     }

◆ isUserSetupAllowed()

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

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                         {
         return false;
     }

◆ order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                         {
         return 0;
     }

◆ postInit()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
 
     }

◆ requiresUser()

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

inline

org.keycloak.authentication.Authenticatorを実装しています。

                                   {
         return true;
     }

◆ setRequiredActions()

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

inline

org.keycloak.authentication.Authenticatorを実装しています。

                                                                                               {
 
     }

メンバ詳解

◆ REQUIREMENT_CHOICES

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

static

初期値:

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

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

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/authenticators/resetcred/AbstractSetRequiredActionAuthenticator.java

公開メンバ関数

静的公開変数類

詳解

関数詳解

◆ action()

◆ authenticate()

◆ close()

◆ configuredFor()

◆ create()

◆ getConfigProperties()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ getReferenceCategory()

◆ getRequirementChoices()

◆ init()

◆ isConfigurable()

◆ isUserSetupAllowed()

◆ order()

◆ postInit()

◆ requiresUser()

◆ setRequiredActions()

メンバ詳解

◆ REQUIREMENT_CHOICES