io.micronaut.security.token.config

Interface TokenConfiguration

All Superinterfaces:

io.micronaut.core.util.Toggleable

All Known Implementing Classes:

TokenConfigurationProperties

public interface TokenConfiguration
extends io.micronaut.core.util.Toggleable

Defines Security Token Configuration.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME_KEY
static java.lang.String	DEFAULT_ROLES_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNameKey() Authentication attributes map key for the user's name.
java.lang.String	getRolesName() Key which will be used in the Authentication.getAttributes() for the User`s roles.

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Detail

DEFAULT_ROLES_NAME

static final java.lang.String DEFAULT_ROLES_NAME

See Also:

Constant Field Values

DEFAULT_NAME_KEY

static final java.lang.String DEFAULT_NAME_KEY

See Also:

Constant Field Values

Method Detail

getRolesName

@NonNull
java.lang.String getRolesName()

Key which will be used in the Authentication.getAttributes() for the User`s roles. Default value "roles".

Returns:

The key used for the user's roles within the user's attributes. e.g. "roles".

getNameKey

@NonNull
java.lang.String getNameKey()

Authentication attributes map key for the user's name. Default value "username".

Returns:

The key used for the user's name within the user's attributes. e.g. "sub".