公開メンバ関数 | |
| ClientAuthenticator | create () |
| boolean | isConfigurable () |
| List< ProviderConfigProperty > | getConfigPropertiesPerClient () |
| Map< String, Object > | getAdapterConfiguration (ClientModel client) |
| Set< String > | getProtocolAuthenticatorMethods (String loginProtocol) |
| String | getDisplayType () |
| String | getReferenceCategory () |
| AuthenticationExecutionModel.Requirement [] | getRequirementChoices () |
| boolean | isUserSetupAllowed () |
詳解
Factory for creating ClientAuthenticator instances. This is a singleton and created when Keycloak boots.
You must specify a file META-INF/services/org.keycloak.authentication.ClientAuthenticatorFactory in the jar that this class is contained in This file must have the fully qualified class name of all your ClientAuthenticatorFactory classes
関数詳解
◆ create()
| ClientAuthenticator org.keycloak.authentication.ClientAuthenticatorFactory.create | ( | ) |
◆ getAdapterConfiguration()
| Map<String, Object> org.keycloak.authentication.ClientAuthenticatorFactory.getAdapterConfiguration | ( | ClientModel | client | ) |
Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client. Some implementations may return just template and user needs to edit the values according to his environment (For example fill the location of keystore file)
- 戻り値
◆ getConfigPropertiesPerClient()
| List<ProviderConfigProperty> org.keycloak.authentication.ClientAuthenticatorFactory.getConfigPropertiesPerClient | ( | ) |
List of config properties for this client implementation. Those will be shown in admin console in clients credentials tab and can be configured per client. Applicable only if "isConfigurablePerClient" is true
- 戻り値
◆ getDisplayType()
|
inherited |
Friendly name for the authenticator
- 戻り値
◆ getProtocolAuthenticatorMethods()
| Set<String> org.keycloak.authentication.ClientAuthenticatorFactory.getProtocolAuthenticatorMethods | ( | String | loginProtocol | ) |
Get authentication methods for the specified protocol
- 引数
-
loginProtocol corresponds to org.keycloak.protocol.LoginProtocolFactory#getId
- 戻り値
- name of supported client authenticator methods in the protocol specific "language"
◆ getReferenceCategory()
|
inherited |
General authenticator type, i.e. totp, password, cert.
- 戻り値
- null if not a referencable category
◆ getRequirementChoices()
|
inherited |
What requirement settings are allowed.
- 戻り値
◆ isConfigurable()
| boolean org.keycloak.authentication.ClientAuthenticatorFactory.isConfigurable | ( | ) |
Is this authenticator configurable globally?
- 戻り値
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?
- 戻り値
このインタフェース詳解は次のファイルから抽出されました:
- D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/authentication/ClientAuthenticatorFactory.java
