org.neo4j.server.security.enterprise.auth.plugin.spi

Interface AuthenticationInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

CacheableAuthenticationInfo, CustomCacheableAuthenticationInfo

public interface AuthenticationInfo
extends Serializable

An object that can be returned as the result of successful authentication by an AuthenticationPlugin.

See Also:

AuthenticationPlugin.authenticate(AuthToken)

Method Summary

Modifier and Type	Method and Description
static AuthenticationInfo	of(Object principal)
Object	principal() Should return a principal that uniquely identifies the authenticated subject within this authentication provider.

Method Detail

principal

Object principal()

Should return a principal that uniquely identifies the authenticated subject within this authentication provider.

Typically this is the same as the principal within the auth token map.

Returns:

a principal that uniquely identifies the authenticated subject within this authentication provider.

of

static AuthenticationInfo of(Object principal)