AuthnApiPlugin (PingFederate Server SDK)

```
public interface AuthnApiPlugin
```
The interface that all API-capable plugins must implement. Implementing this interface signals to PingFederate that the plugin is capable of handling requests sent via the authentication API.

Since:

9.3

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default AuthnApiPluginDescriptor`	`getApiPluginDescriptor()`	Returns a descriptor with additional metadata about the API plugin.
`PluginApiSpec`	`getApiSpec()`	Returns metadata about the API states and actions that this plugin exposes.

- Method Detail
  - getApiSpec
```
PluginApiSpec getApiSpec()
```
    Returns metadata about the API states and actions that this plugin exposes. The information returned by this method is used by PingFederate to generate API documentation. For API plugins that are not interactive the result of this method is ignored.
    
    Returns:
    
    The API specification for the plugin.
    
    Since:
    
    9.3
  - getApiPluginDescriptor
```
default AuthnApiPluginDescriptor getApiPluginDescriptor()
```
    Returns a descriptor with additional metadata about the API plugin.
    
    Returns:
    
    Additional metadata about the API plugin.
    
    Since:
    
    9.3