Authenticator (Obsidian Scheduler - Embedded API)

All Known Implementing Classes:

LdapAuthenticator
```
public interface Authenticator
```
The interface that must be implemented by any custom Authenticator to be used by Obsidian.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`Authenticator.AuthenticationFailedException`
`static class`	`Authenticator.AuthenticationMembershipFailedException`
`static class`	`Authenticator.AuthenticatorException`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`User`	`authenticate(java.lang.String user, java.lang.String pass)`	This interface can be used to provide any authentication user/role mapping implementation that is desired for use by Obsidian Scheduler.
`default User`	`authenticateREST(java.lang.String user, java.lang.String pass)`	This optional interface is to allow custom authentication for REST usage.
`default java.lang.String`	`getButtonLabel()`	Label for the SSO sign-in button when this authenticator is active.

- Method Detail
  - authenticate
```
User authenticate(java.lang.String user,
                  java.lang.String pass)
           throws Authenticator.AuthenticationFailedException
```
    This interface can be used to provide any authentication user/role mapping implementation that is desired for use by Obsidian Scheduler. Given a user name and a password either return a valid user object or throw an AuthenticationFailedException. A user object should have its roles defined in addition to implementing the getUserListFromRoles method.
    
    Throws:
    
    Authenticator.AuthenticationFailedException
  - authenticateREST
```
default User authenticateREST(java.lang.String user,
                              java.lang.String pass)
                       throws Authenticator.AuthenticationFailedException
```
    This optional interface is to allow custom authentication for REST usage. For example, ignoring features such as last login timestamps and MFA.
    
    Throws:
    
    Authenticator.AuthenticationFailedException
  - getButtonLabel
```
default java.lang.String getButtonLabel()
```
    Label for the SSO sign-in button when this authenticator is active. Non-SSO authenticators return the empty string.