Package se.curity.identityserver.sdk.service.authenticationaction

Interface AuthenticatorDescriptorFactory

public interface AuthenticatorDescriptorFactory

This service allows the plugin to map from ACR strings to configured authenticators as well as from authenticator ID strings to AuthenticatorDescriptor. It can only be used as a service in the Authentication Action plugins. Usage in other plugins will result in errors during boot.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
AuthenticatorDescriptor	getAuthenticatorDescriptor(String authenticatorId)	The AuthenticatorDescritor matching the authenticator ID
NonEmptyList<AuthenticatorDescriptor>	getAuthenticatorDescriptors(String acr)	Returns the authenticators in the current profile that match the given ACR.

Method Details

getAuthenticatorDescriptors

NonEmptyList<AuthenticatorDescriptor> getAuthenticatorDescriptors(String acr)
                                                           throws AuthenticatorNotConfiguredException

Returns the authenticators in the current profile that match the given ACR. Normally this is only one, but it is allowed to configure many authenticators with the same ACR which is why a list is returned

Parameters:

acr - The acr to lookup

Returns:

A non-empty list of AuthenticatorDescriptors matching the ACR

Throws:

AuthenticatorNotConfiguredException - if no match is found

getAuthenticatorDescriptor

AuthenticatorDescriptor getAuthenticatorDescriptor(String authenticatorId)
                                            throws AuthenticatorNotConfiguredException

The AuthenticatorDescritor matching the authenticator ID

Parameters:

authenticatorId - the ID to lookup

Returns:

The descriptor for the ID

Throws:

AuthenticatorNotConfiguredException - if no authenticator exist for the given ID