org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator の継承関係図

org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator 連携図

公開メンバ関数
Response	errorResponse (int status, String error, String errorDescription)

void	action (AuthenticationFlowContext context)

void	close ()

Authenticator	create (KeycloakSession session)

void	init (Config.Scope config)

void	postInit (KeycloakSessionFactory factory)

void	authenticate (AuthenticationFlowContext context)

boolean	requiresUser ()

boolean	configuredFor (KeycloakSession session, RealmModel realm, UserModel user)

void	setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user)

String	getId ()

default int	order ()

String	getDisplayType ()

String	getReferenceCategory ()

boolean	isConfigurable ()

AuthenticationExecutionModel.Requirement []	getRequirementChoices ()

boolean	isUserSetupAllowed ()

String	getHelpText ()

List< ProviderConfigProperty >	getConfigProperties ()

詳解

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ action()

void org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator.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.directgrant.AbstractDirectGrantAuthenticator.close ( )

inline

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

                         {
 
     }

◆ configuredFor()

boolean org.keycloak.authentication.Authenticator.configuredFor	(	KeycloakSession	session,
		RealmModel	realm,
		UserModel	user
	)

inherited

Is this authenticator configured for this user.

引数

session
realm
user

戻り値

◆ create()

Authenticator org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator.create ( KeycloakSession session )

inline

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

                                                          {
         return this;
     }

◆ errorResponse()

Response org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator.errorResponse	(	int	status,
		String	error,
		String	errorDescription
	)

inline

                                                                                      {
         OAuth2ErrorRepresentation errorRep = new OAuth2ErrorRepresentation(error, errorDescription);
         return Response.status(status).entity(errorRep).type(MediaType.APPLICATION_JSON_TYPE).build();
     }

◆ getConfigProperties()

List<ProviderConfigProperty> org.keycloak.provider.ConfiguredProvider.getConfigProperties ( )

inherited

◆ 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.ConfigurableAuthenticatorFactory.getReferenceCategory ( )

inherited

General authenticator type, i.e. totp, password, cert.

戻り値: null if not a referencable category

◆ getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.ConfigurableAuthenticatorFactory.getRequirementChoices ( )

inherited

What requirement settings are allowed.

戻り値

◆ init()

void org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator.init ( Config.Scope config )

inline

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

                                           {
 
     }

◆ isConfigurable()

boolean org.keycloak.authentication.ConfigurableAuthenticatorFactory.isConfigurable ( )

inherited

Is this authenticator configurable?

戻り値

◆ isUserSetupAllowed()

boolean org.keycloak.authentication.ConfigurableAuthenticatorFactory.isUserSetupAllowed ( )

inherited

Does this authenticator have required actions that can set if the user does not have this authenticator set up?

戻り値

◆ 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.directgrant.AbstractDirectGrantAuthenticator.postInit ( KeycloakSessionFactory factory )

inline

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

                                                          {
 
     }

◆ requiresUser()

boolean org.keycloak.authentication.Authenticator.requiresUser ( )

inherited

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

戻り値

◆ setRequiredActions()

void org.keycloak.authentication.Authenticator.setRequiredActions	(	KeycloakSession	session,
		RealmModel	realm,
		UserModel	user
	)

inherited

Set actions to configure authenticator

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

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/authenticators/directgrant/AbstractDirectGrantAuthenticator.java

公開メンバ関数

詳解

関数詳解

◆ action()

◆ authenticate()

◆ close()

◆ configuredFor()

◆ create()

◆ errorResponse()

◆ getConfigProperties()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ getReferenceCategory()

◆ getRequirementChoices()

◆ init()

◆ isConfigurable()

◆ isUserSetupAllowed()

◆ order()

◆ postInit()

◆ requiresUser()

◆ setRequiredActions()