公開メンバ関数 | |
| void | authenticate (AuthenticationFlowContext context) |
| void | action (AuthenticationFlowContext context) |
| boolean | requiresUser () |
| boolean | configuredFor (KeycloakSession session, RealmModel realm, UserModel user) |
| void | setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user) |
詳解
This interface is for users that want to add custom authenticators to an authentication flow. You must implement this interface as well as an AuthenticatorFactory.
- バージョン
- Revision
- 1
関数詳解
◆ action()
| void org.keycloak.authentication.Authenticator.action | ( | AuthenticationFlowContext | context | ) |
Called from a form action invocation.
- 引数
-
context
◆ authenticate()
| void org.keycloak.authentication.Authenticator.authenticate | ( | AuthenticationFlowContext | context | ) |
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
◆ configuredFor()
| boolean org.keycloak.authentication.Authenticator.configuredFor | ( | KeycloakSession | session, |
| RealmModel | realm, | ||
| UserModel | user | ||
| ) |
Is this authenticator configured for this user.
- 引数
-
session realm user
- 戻り値
◆ requiresUser()
| boolean org.keycloak.authentication.Authenticator.requiresUser | ( | ) |
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 | ||
| ) |
Set actions to configure authenticator
このインタフェース詳解は次のファイルから抽出されました:
- D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/authentication/Authenticator.java
