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

Interface AuthInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

CacheableAuthInfo

public interface AuthInfo
extends Serializable

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

This result type combines authentication and authorization information.

NOTE: If authentication caching is enabled the result type CacheableAuthInfo should be used instead.

See Also:

AuthPlugin.authenticateAndAuthorize(AuthToken), CacheableAuthInfo

Method Summary

Modifier and Type	Method and Description
static AuthInfo	of(Object principal, Collection<String> roles)
Object	principal() Should return a principal that uniquely identifies the authenticated subject within this auth provider.
Collection<String>	roles() Should return the roles assigned to this principal.

Method Detail

principal

Object principal()

Should return a principal that uniquely identifies the authenticated subject within this auth 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 auth provider.

roles

Collection<String> roles()

Should return the roles assigned to this principal.

Returns:

the roles assigned to this principal

of

static AuthInfo of(Object principal,
                   Collection<String> roles)