Interface AuthenticatorDescriptor


public interface AuthenticatorDescriptor
This class represents a configured authenticator in the current profile. It can be obtained by using the AuthenticatorDescriptorFactory, or by usage directly in the configuration object as a service. If used in the configuration the admin configures the ID in the UI and the corresponding descriptor is returned to the plugin.

Can only be used inside Authentication Action plugins.

Since:
3.0.0
  • Method Details

    • getId

      String getId()
      The configured ID for the authenticator
      Returns:
      the string ID of the authenticator
    • getAcr

      String getAcr()
      The configured ACR for the authenticator
      Returns:
      the string ACR of the authenticator
    • getDescription

      @Nullable @Nullable String getDescription()
      The configured description for the authenticator if present.
      Returns:
      The configured description if present, otherwise null
    • getAccountDomain

      @Nullable @Nullable AccountDomain getAccountDomain()
      The configured domain for the authenticator if present
      Returns:
      The account domain of the authenticator or null if not present
    • getType

      String getType()
      The configured authenticator type.
      Returns:
      the string type of the authenticator.
      Since:
      6.6