Package org.apache.polaris.service.auth

Interface PrincipalAuthInfo

All Known Subinterfaces:

DecodedToken

public interface PrincipalAuthInfo

Principal information extracted from authentication data (typically, an access token) by the configured authentication mechanism. Used to determine the principal id, name, and roles while authenticating a request.

See Also:

• DefaultAuthenticator

Method Summary

Modifier and Type	Method	Description
Long	getPrincipalId()	The principal id, or null if unknown.
String	getPrincipalName()	The principal name, or null if unknown.
Set<String>	getPrincipalRoles()	The principal roles present in the token.

Method Details

getPrincipalId

@Nullable
Long getPrincipalId()

The principal id, or null if unknown. Used for principal lookups by id.

getPrincipalName

@Nullable
String getPrincipalName()

The principal name, or null if unknown. Used for principal lookups by name.

getPrincipalRoles

Set<String> getPrincipalRoles()

The principal roles present in the token. The special DefaultAuthenticator.PRINCIPAL_ROLE_ALL can be used to denote a request for all principal roles that the principal has access to.