Serialized Form (Broadleaf Authentication Services 1.6.1-SNAPSHOT API)

Package com.broadleafcommerce.auth.client.domain
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - registrationId
```
String registrationId
```
      The ID of the registered provider. Should match OAuthClientRegistrationWrapper.getRegistrationId().
    - issuerUri
```
String issuerUri
```
      URI that can either be an OpenID Connect discovery endpoint or an OAuth 2.0 Authorization Server Metadata endpoint defined by RFC 8414.
      This is used to gather the provider details which would otherwise be unknown since some providers only provide this to integrators.
    - authorizationUri
```
String authorizationUri
```
      See Also:
      
      ClientRegistration.ProviderDetails#getAuthorizationUri()
    - tokenUri
```
String tokenUri
```
      See Also:
      
      ClientRegistration.ProviderDetails#getTokenUri()
    - userInfoEndpoint
```
OAuthClientRegistrationProviderDetails.UserInfoEndpoint userInfoEndpoint
```
      See Also:
      
      ClientRegistration.ProviderDetails#getUserInfoEndpoint()
    - jwkSetUri
```
String jwkSetUri
```
      See Also:
      
      ClientRegistration.ProviderDetails#getJwkSetUri()
    - configurationMetadata
```
Map<K,V> configurationMetadata
```
      See Also:
      
      ClientRegistration.ProviderDetails#getConfigurationMetadata()
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails.UserInfoEndpoint extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - uri
```
String uri
```
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint#getUri()
    - authenticationMethod
```
String authenticationMethod
```
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint#getAuthenticationMethod()
    - userNameAttributeName
```
String userNameAttributeName
```
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint#getUserNameAttributeName()
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationWrapper extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      The system ID of the registration
    - tenantId
```
String tenantId
```
      The ID of the Tenant this registration belongs to. Different tenants can have different credentials for the same client provider (e.g. Facebook, Google).
    - registrationId
```
String registrationId
```
      See Also:
      
      ClientRegistration.getRegistrationId()
    - clientId
```
String clientId
```
      See Also:
      
      ClientRegistration.getClientId()
    - clientSecret
```
String clientSecret
```
      See Also:
      
      ClientRegistration.getClientSecret()
    - clientAuthenticationMethod
```
String clientAuthenticationMethod
```
      See Also:
      
      ClientRegistration.getClientAuthenticationMethod()
    - authorizationGrantType
```
String authorizationGrantType
```
      See Also:
      
      ClientRegistration.getAuthorizationGrantType()
    - redirectUriTemplate
```
String redirectUriTemplate
```
      See Also:
      
      ClientRegistration.getRedirectUriTemplate()
    - scopes
```
Set<E> scopes
```
      See Also:
      
      ClientRegistration.getScopes()
    - providerDetails
```
OAuthClientRegistrationProviderDetails providerDetails
```
      See Also:
      
      ClientRegistration.getProviderDetails(), OAuthClientRegistrationProviderDetails
    - clientName
```
String clientName
```
      See Also:
      
      ClientRegistration.getClientName()
Package com.broadleafcommerce.auth.client.provider.authentication
- Class com.broadleafcommerce.auth.client.provider.authentication.BroadleafOAuthClientAuthenticationDetails extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
Package com.broadleafcommerce.auth.client.provider.jpa.domain
- Class com.broadleafcommerce.auth.client.provider.jpa.domain.JpaOAuthClientProviderDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - authorizationUri
```
String authorizationUri
```
    - tokenUri
```
String tokenUri
```
    - jwkSetUri
```
String jwkSetUri
```
    - registrationId
```
String registrationId
```
    - configurationMetadata
```
Map<K,V> configurationMetadata
```
    - userInfoUri
```
String userInfoUri
```
    - userInfoAuthenticationMethod
```
String userInfoAuthenticationMethod
```
    - userInfoUserNameAttributeName
```
String userInfoUserNameAttributeName
```
- Class com.broadleafcommerce.auth.client.provider.jpa.domain.JpaOAuthClientRegistration extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - tenantId
```
String tenantId
```
    - registrationId
```
String registrationId
```
    - clientId
```
String clientId
```
    - clientSecret
```
String clientSecret
```
    - clientAuthenticationMethod
```
String clientAuthenticationMethod
```
    - authorizationGrantType
```
String authorizationGrantType
```
    - redirectUriTemplate
```
String redirectUriTemplate
```
    - scopes
```
Set<E> scopes
```
    - clientName
```
String clientName
```
    - providerDetails
```
JpaOAuthClientProviderDetails providerDetails
```
Package com.broadleafcommerce.auth.passcode.service
- Class com.broadleafcommerce.auth.passcode.service.PasscodeNotConsumedException extends Exception implements Serializable
Package com.broadleafcommerce.auth.resource.domain
- Class com.broadleafcommerce.auth.resource.domain.RestrictedPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - restriction
```
Restriction restriction
```
      Represents the restriction on this permission.
    - permission
```
UserPermissionRef permission
```
      Represents the permission that is being restricted.
- Class com.broadleafcommerce.auth.resource.domain.RestrictedRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - restriction
```
Restriction restriction
```
      Represents the restriction on this role.
    - role
```
UserRoleRef role
```
      Represents the role that is being restricted.
- Class com.broadleafcommerce.auth.resource.domain.Restriction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
String type
```
      Represents the type of the restriction.
    - targets
```
Set<E> targets
```
      Represents the targets of the restriction.
- Class com.broadleafcommerce.auth.resource.domain.User extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - firstName
```
String firstName
```
      The first name of the user, if the fullName is not being used for the user.
    - middleName
```
String middleName
```
      The middle name of the user, if the fullName is not being used for the user.
    - lastName
```
String lastName
```
      The last name of the user, if the fullName is not being used for the user.
    - fullName
```
String fullName
```
      The full name of the user, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.
    - username
```
String username
```
      What this user uses to actually log in. May be the same as User.email, but that is not required.
      The username is case insensitive, so it will always be stored lowercase.
    - email
```
String email
```
      The user's email address.
    - serviceId
```
String serviceId
```
      If this user was synchronized from a BLC service (ex: the admin user service or the customer service), this field will be the ID value used by that service for this user.
      If this value is set, there should also be a value set for User.type.
      There is a requirement that only if both values are non-null, a combination of this field and User.type will be unique across all records. There is no uniqueness guarantee for records which have a null service ID or null User.type.
      
      See Also:
      
      User.type
    - type
```
String type
```
      Represents the type of user this is. This value must be supplied if User.serviceId is set.
      
      See Also:
      
      UserType, User.serviceId
    - externalId
```
String externalId
```
      Intended to hold any unique identifier for this user as known by an external (non-BLC) system. For example, many implementations may integrate or import/export data from other systems that manage their own unique identifiers.
    - tenantId
```
String tenantId
```
      The id of the tenant this user is associated with.
    - applicationIds
```
Set<E> applicationIds
```
      This field only applies to UserType.ADMIN users.
      The ids of applications this user is a member of. If this is non-empty, this user is restricted to these applications.
    - tenantAccess
```
boolean tenantAccess
```
      Indicates whether this user has access at the tenant level or not.
      This field only applies to UserType.ADMIN users.
    - applicationAccess
```
boolean applicationAccess
```
      Indicates whether this user has access at the application level or not.
      This field only applies to UserType.ADMIN users. UserType.CUSTOMER will always have application level access regardless of this value.
    - customerContextId
```
String customerContextId
```
      This field only applies to UserType.CUSTOMER users.
      The id of the customer context this user is a member of. If this is set, this user is restricted to this customer context.
    - attributes
```
Map<K,V> attributes
```
      Arbitrary attributes associated with this user. May include custom claims, customer segment ids, or any other attributes that are not first class user fields.
    - active
```
boolean active
```
      A flag indicating whether the user account is enabled. If false, they will not be able to log in.
      This flag should be used if a user needs to be enabled/disabled for administrative reasons.
    - locked
```
boolean locked
```
      A flag indicating whether the admin user account is locked. If false, they will not be able to log in and a LockedException will be thrown on a login attempt.
      This flag is used to limit invalid login attempt.
    - expired
```
boolean expired
```
      A flag indicating whether the admin user account is expired. If false, they will not be able to log in.
      This flag can be used to declare an account as expired and unusable, but currently there is no logic for that. It will always be false.
    - changePasswordRequired
```
boolean changePasswordRequired
```
      A flag indicating whether the admin user account requires a password reset. If true, they will not be able to log in until they reset their password.
    - impersonationAllowed
```
boolean impersonationAllowed
```
      A flag indicated whether or not this user is allowed to be impersonated.
    - serverId
```
String serverId
```
      The ID of the authorization server that this user is a member of.
    - lastUpdated
```
Instant lastUpdated
```
      Indicates when this record was last updated.
    - archived
```
boolean archived
```
      This entity is soft-deleted instead of hard-deleted, and this field is set to true when the entity is soft-deleted.
    - roles
```
Set<E> roles
```
      The roles that this user is assigned. The user is granted all permissions that each of these roles are directly assigned or inherit from their ancestors.
    - permissions
```
Set<E> permissions
```
      The permissions that this user is directly assigned (in addition to permissions granted through User.roles).
    - restrictions
```
Set<E> restrictions
```
      The data restrictions that control the data this user is permitted to access.
    - restrictedRoles
```
Set<E> restrictedRoles
```
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictedPermissions
```
Set<E> restrictedPermissions
```
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - lockedTime
```
Instant lockedTime
```
      If this user is locked out, the time that the user was locked.
Package com.broadleafcommerce.auth.resource.web.endpoint.exception
- Class com.broadleafcommerce.auth.resource.web.endpoint.exception.InvalidApplicationContextException extends Exception implements Serializable
- Class com.broadleafcommerce.auth.resource.web.endpoint.exception.InvalidApplicationIdException extends Exception implements Serializable
Package com.broadleafcommerce.auth.security.domain
- Class com.broadleafcommerce.auth.security.domain.JpaUserPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - lastUpdated
```
Instant lastUpdated
```
      We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
      
      See Also:
      
      UserPermission.lastUpdated
    - archived
```
boolean archived
```
      See Also:
      
      UserPermission.archived
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestrictedPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - user
```
JpaUser user
```
    - permission
```
JpaUserPermission permission
```
    - restrictionType
```
String restrictionType
```
    - restrictionTargets
```
Set<E> restrictionTargets
```
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestrictedRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - user
```
JpaUser user
```
    - role
```
JpaUserRole role
```
    - restrictionType
```
String restrictionType
```
    - restrictionTargets
```
Set<E> restrictionTargets
```
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestriction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - user
```
JpaUser user
```
    - restrictionType
```
String restrictionType
```
    - restrictionTargets
```
Set<E> restrictionTargets
```
- Class com.broadleafcommerce.auth.security.domain.JpaUserRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - permissions
```
Set<E> permissions
```
    - parentRoleId
```
String parentRoleId
```
      A soft reference to the parent of this role.
      
      See Also:
      
      UserRole.parentRoleId
    - lastUpdated
```
Instant lastUpdated
```
      We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
      
      See Also:
      
      UserRole.lastUpdated
    - archived
```
boolean archived
```
      See Also:
      
      UserRole.archived
- Class com.broadleafcommerce.auth.security.domain.PermissionScope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - scope
```
SecurityScope scope
```
    - permission
```
String permission
```
      The permission or base root of a permission which can expand to a CRUD operation.
      Note that if a permission name starts with a PermissionType prefix, it must be declared as a permission root by setting PermissionScope.permissionRoot to true.
      
      See Also:
      
      PermissionType, PermissionScope.permissionRoot
    - permissionRoot
```
boolean permissionRoot
```
      Is this the root of a permission? If this is false this is a direct mapping between a permission and a scope. In other words, the usual CREATE_, READ_, UPDATE_, DELETE_, ALL_ prefixes do not apply to this scope/permission relationship.
- Class com.broadleafcommerce.auth.security.domain.SecurityScope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - open
```
boolean open
```
      Whether all users should have this scope assigned to them, regardless of what their underlying permissions are.
Package com.broadleafcommerce.auth.security.service.exception
- Class com.broadleafcommerce.auth.security.service.exception.InvalidUserRoleDeleteException extends RuntimeException implements Serializable
Package com.broadleafcommerce.auth.server.domain
- Class com.broadleafcommerce.auth.server.domain.AuthorizedClient extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      The primary key of this authorized client.
    - serverId
```
String serverId
```
      The ID of the authorization server this authorized client is part of.
    - friendlyName
```
String friendlyName
```
      The friendly name of this authorized client. Intended for display purposes
    - clientId
```
String clientId
```
      The OAuth2 client ID for this authorized client. Usually generated as a randomized string.
    - tokenTimeoutSeconds
```
Integer tokenTimeoutSeconds
```
      The period of time, in seconds, that an access token issued will be valid for.
    - refreshTokenTimeoutSeconds
```
Integer refreshTokenTimeoutSeconds
```
      The period of time, in seconds, that an refresh token issued will be valid for. A refresh token used within this timeframe will become invalid because of rotation. It should be generally considered that a refresh token can be used once.
    - resourceIds
```
Set<E> resourceIds
```
      The resources that this client can access. Can be ignored by callers if empty.
    - grantTypes
```
Set<E> grantTypes
```
      The grant types for which this client is authorized.
    - redirectUris
```
Set<E> redirectUris
```
      The pre-defined redirect URIs for this client to use during the "authorization_code" access grant. See OAuth spec, section 4.1.1.
      Any of these values may be relative, and if so, the DefaultClientDetailsService will use the TenantUrlResolver to determine the base URL to resolve them against such that ultimately they are absolute. If resolution to an absolute URL fails for whatever reason, the relative URL will be omitted from the final ClientDetails.getRegisteredRedirectUri().
      
      See Also:
      
      DefaultClientDetailsService, TenantUrlResolver
    - scopes
```
Set<E> scopes
```
      The scopes for this client. Empty if the client isn't scoped.
    - permissions
```
Set<E> permissions
```
      Returns the permissions that are granted to the OAuth client. Cannot return null. Note that these are NOT the permissions that are granted to the user with an authorized access token. Instead, these permissions are inherent to the client itself.
    - isAdmin
```
boolean isAdmin
```
      Whether or not this authorized client is used for authorizing admin users. This is generally used in discovering the authorized client or authorization server for admin users.
    - applicationId
```
String applicationId
```
      Populated if this authorized client is used for authorizing customer users in a certain application. This is generally used in discovering the authorized client or authorization server for customer users.
    - attributes
```
Map<K,V> attributes
```
      Additional attributes for this client, not needed by the vanilla OAuth protocol but might be useful, for example, for storing descriptive information.
    - defaultRedirectUri
```
String defaultRedirectUri
```
      The default redirect URI to use if a user accesses a login page without a valid redirect cookie
Package com.broadleafcommerce.auth.server.provider.jpa.domain
- Class com.broadleafcommerce.auth.server.provider.jpa.domain.JpaAuthorizationServer extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - tenantId
```
String tenantId
```
    - name
```
String name
```
    - friendlyName
```
String friendlyName
```
    - inactivityTimeoutSeconds
```
Integer inactivityTimeoutSeconds
```
    - requireLoginTimeoutSeconds
```
Integer requireLoginTimeoutSeconds
```
    - templatePath
```
String templatePath
```
    - ssoEnabled
```
boolean ssoEnabled
```
    - crossOrigin
```
boolean crossOrigin
```
    - defaultUserRoles
```
Set<E> defaultUserRoles
```
    - defaultUserPermissions
```
Set<E> defaultUserPermissions
```
    - attributes
```
Map<K,V> attributes
```
    - defaultRedirectUri
```
String defaultRedirectUri
```
    - failedLoginAttemptsAllowed
```
Integer failedLoginAttemptsAllowed
```
    - lockoutDurationMinutes
```
Long lockoutDurationMinutes
```
    - loginFailDecayMinutes
```
Long loginFailDecayMinutes
```
    - embeddedLoginEnabled
```
boolean embeddedLoginEnabled
```
    - resetPasswordUnlocksUser
```
Boolean resetPasswordUnlocksUser
```
    - lockedUserCanResetPassword
```
Boolean lockedUserCanResetPassword
```
- Class com.broadleafcommerce.auth.server.provider.jpa.domain.JpaAuthorizedClient extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - serverId
```
String serverId
```
    - friendlyName
```
String friendlyName
```
    - clientId
```
String clientId
```
    - clientSecret
```
String clientSecret
```
    - tokenTimeoutSeconds
```
int tokenTimeoutSeconds
```
    - refreshTokenTimeoutSeconds
```
Integer refreshTokenTimeoutSeconds
```
    - refreshTokenRotationIntervalSeconds
```
Integer refreshTokenRotationIntervalSeconds
```
    - resourceIds
```
Set<E> resourceIds
```
    - grantTypes
```
Set<E> grantTypes
```
    - redirectUris
```
Set<E> redirectUris
```
    - scopes
```
Set<E> scopes
```
    - permissions
```
Set<E> permissions
```
    - isAdmin
```
boolean isAdmin
```
    - applicationId
```
String applicationId
```
    - attributes
```
Map<K,V> attributes
```
    - defaultRedirectUri
```
String defaultRedirectUri
```
Package com.broadleafcommerce.auth.server.web.endpoint
- Class com.broadleafcommerce.auth.server.web.endpoint.ClientDiscoveryEndpoint.ClientDiscoveryResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
```
String clientId
```
      The discovered authorized client ID
    - serverId
```
String serverId
```
      The discovered authorization server ID
Package com.broadleafcommerce.auth.tenant.provider.jpa.domain
- Class com.broadleafcommerce.auth.tenant.provider.jpa.domain.JpaApplication extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      See Also:
      
      Application.getId()
    - identifierType
```
String identifierType
```
      See Also:
      
      Application.getIdentifierType()
    - identifierValue
```
String identifierValue
```
      See Also:
      
      Application.getIdentifierValue()
    - deactivated
```
boolean deactivated
```
      See Also:
      
      Application.isDeactivated()
    - customerContextId
```
String customerContextId
```
      See Also:
      
      Application.getCustomerContextId()
    - tenantId
```
String tenantId
```
      See Also:
      
      Application@getTen
    - lastUpdated
```
Instant lastUpdated
```
      We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
      
      See Also:
      
      Application.lastUpdated
    - isMarketplace
```
boolean isMarketplace
```
      See Also:
      
      Application.isMarketplace()
Package com.broadleafcommerce.auth.token.provider.jpa.domain
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken1 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken2 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken3 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken4 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken5 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken6 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - ancestor
```
String ancestor
```
    - isRotated
```
boolean isRotated
```
    - rotationExpiration
```
Long rotationExpiration
```
    - expiration
```
Long expiration
```
Package com.broadleafcommerce.auth.token.service
- Class com.broadleafcommerce.auth.token.service.DefaultOriginalAwareOAuth2RefreshToken extends org.springframework.security.oauth2.common.DefaultExpiringOAuth2RefreshToken implements Serializable
  - Serialized Fields
    - oid
```
String oid
```
Package com.broadleafcommerce.auth.user.api.dto
- Class com.broadleafcommerce.auth.user.api.dto.ChangePasswordForm extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currentPassword
```
String currentPassword
```
    - newPassword
```
String newPassword
```
    - newPasswordConfirm
```
String newPasswordConfirm
```
    - client_id
```
String client_id
```
- Class com.broadleafcommerce.auth.user.api.dto.ResetPasswordForm extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - username
```
String username
```
    - token
```
String token
```
    - password
```
String password
```
    - client_id
```
String client_id
```
Package com.broadleafcommerce.auth.user.domain
- Class com.broadleafcommerce.auth.user.domain.AuthenticationEvent extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - messageType
```
String messageType
```
      The message type for this event.
      
      See Also:
      
      AuthenticationMessageType
    - user
```
User user
```
      The user that made the request
    - attributes
```
Map<K,V> attributes
```
      Any additional attributes that a service receiving the request may need
    - contextInfo
```
com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
```
      The ContextInfo derived from the original request containing tenant and sandbox info.
- Class com.broadleafcommerce.auth.user.domain.DefaultOAuth2UserDetails extends org.springframework.security.core.userdetails.User implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - clientId
```
String clientId
```
    - impersonationAllowed
```
boolean impersonationAllowed
```
    - restrictions
```
Map<K,V> restrictions
```
      See Also:
      
      PrivilegeSummary#getRestrictions().
    - restrictedAuthorities
```
Map<K,V> restrictedAuthorities
```
      See Also:
      
      PrivilegeSummary#getRestrictedAuthorities().
Package com.broadleafcommerce.auth.user.endpoint
- Class com.broadleafcommerce.auth.user.endpoint.ImpersonationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - client_id
```
String client_id
```
    - impersonated_sub
```
String impersonated_sub
```
    - impersonated_client_id
```
String impersonated_client_id
```
    - redirect_uri
```
String redirect_uri
```
Package com.broadleafcommerce.auth.user.exception
- Class com.broadleafcommerce.auth.user.exception.UserNotActiveException extends RuntimeException implements Serializable
Package com.broadleafcommerce.auth.user.listener.domain
- Class com.broadleafcommerce.auth.user.listener.domain.AdminPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - tenantId
```
String tenantId
```
    - businessDomainType
```
String businessDomainType
```
- Class com.broadleafcommerce.auth.user.listener.domain.AdminPermissionRef extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRestrictedPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - permission
```
AdminPermissionRef permission
```
      Represents the permission that is being restricted.
    - restrictionType
```
String restrictionType
```
      Represents the type of the restriction.
    - restrictionTargets
```
Set<E> restrictionTargets
```
      Represents the targets of the restriction.
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRestrictedRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - role
```
AdminRoleRef role
```
      Represents the role that is being restricted.
    - restrictionType
```
String restrictionType
```
      Represents the type of the restriction.
    - restrictionTargets
```
Set<E> restrictionTargets
```
      Represents the targets of the restriction.
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRestriction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      Represents the id of the User restriction.
    - restrictionType
```
String restrictionType
```
      Represents the type of the restriction.
    - restrictionTargets
```
Set<E> restrictionTargets
```
      Represents the targets of the restriction.
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - permissions
```
Set<E> permissions
```
    - parentRoleId
```
String parentRoleId
```
    - tenantId
```
String tenantId
```
    - businessDomainType
```
String businessDomainType
```
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRoleRef extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
- Class com.broadleafcommerce.auth.user.listener.domain.AdminUser extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - name
```
String name
```
    - username
```
String username
```
    - email
```
String email
```
    - active
```
boolean active
```
    - locked
```
boolean locked
```
    - expired
```
boolean expired
```
    - changePasswordRequired
```
boolean changePasswordRequired
```
    - roles
```
Set<E> roles
```
    - permissions
```
Set<E> permissions
```
    - restrictions
```
Set<E> restrictions
```
      The data restrictions that control the data this user is permitted to access.
    - restrictedRoles
```
Set<E> restrictedRoles
```
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictedPermissions
```
Set<E> restrictedPermissions
```
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - applicationIds
```
Set<E> applicationIds
```
    - tenantId
```
String tenantId
```
    - tenantAccess
```
boolean tenantAccess
```
    - applicationAccess
```
boolean applicationAccess
```
    - businessDomainType
```
String businessDomainType
```
Package com.broadleafcommerce.auth.user.messaging
- Class com.broadleafcommerce.auth.user.messaging.UserCreationEvent extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - user
```
User user
```
    - preview
```
boolean preview
```
      Indicates whether the user was created from a preview context.
    - attributes
```
Map<K,V> attributes
```
      Additional custom information that was provided as part of the user registration process.
      Client implementations may choose to populate and utilize this field for custom behavior.
      
      See Also:
      
      UserRegistration.attributes
Package com.broadleafcommerce.auth.user.provider.jpa.domain
- Class com.broadleafcommerce.auth.user.provider.jpa.domain.JpaPasswordToken extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - token
```
String token
```
    - dateCreated
```
Instant dateCreated
```
    - dateUsed
```
Instant dateUsed
```
    - used
```
boolean used
```
    - userId
```
String userId
```
    - purpose
```
String purpose
```
- Class com.broadleafcommerce.auth.user.provider.jpa.domain.JpaUser extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
    - firstName
```
String firstName
```
      See Also:
      
      User.firstName
    - middleName
```
String middleName
```
      See Also:
      
      User.middleName
    - lastName
```
String lastName
```
      See Also:
      
      User.lastName
    - fullName
```
String fullName
```
      See Also:
      
      User.fullName
    - username
```
String username
```
      See Also:
      
      User.username
    - password
```
String password
```
      See Also:
      
      User.password
    - email
```
String email
```
      See Also:
      
      User.email
    - active
```
boolean active
```
      See Also:
      
      User.active
    - changePasswordRequired
```
boolean changePasswordRequired
```
      See Also:
      
      User.changePasswordRequired
    - locked
```
boolean locked
```
      See Also:
      
      User.locked
    - expired
```
boolean expired
```
      See Also:
      
      User.expired
    - impersonationAllowed
```
boolean impersonationAllowed
```
      See Also:
      
      User.impersonationAllowed
    - serviceId
```
String serviceId
```
      See Also:
      
      User.serviceId
    - type
```
String type
```
      See Also:
      
      User.type
    - externalId
```
String externalId
```
      See Also:
      
      User.externalId
    - tenantAccess
```
boolean tenantAccess
```
      See Also:
      
      User.tenantAccess
    - applicationAccess
```
boolean applicationAccess
```
      See Also:
      
      User.applicationAccess
    - tenantId
```
String tenantId
```
      See Also:
      
      User.tenantId
    - applicationIds
```
Set<E> applicationIds
```
      See Also:
      
      User.applicationIds
    - customerContextId
```
String customerContextId
```
      See Also:
      
      User.customerContextId
    - attributes
```
Map<K,V> attributes
```
      See Also:
      
      User.attributes
    - roles
```
Set<E> roles
```
      See Also:
      
      User.roles
    - permissions
```
Set<E> permissions
```
      See Also:
      
      User.permissions
    - restrictions
```
Set<E> restrictions
```
      See Also:
      
      User.restrictions
    - restrictedRoles
```
Set<E> restrictedRoles
```
      See Also:
      
      User.restrictedRoles
    - restrictedPermissions
```
Set<E> restrictedPermissions
```
      See Also:
      
      User.restrictedPermissions
    - serverId
```
String serverId
```
      See Also:
      
      User.serverId
    - lastUpdated
```
Instant lastUpdated
```
      We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
      
      See Also:
      
      User.lastUpdated
    - archived
```
boolean archived
```
      See Also:
      
      User.archived
    - lockedTime
```
Instant lockedTime
```
- Class com.broadleafcommerce.auth.user.provider.jpa.domain.JpaUserLoginAttempt extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - username
```
String username
```
      The username used in the login attempt. Required.
    - userId
```
String userId
```
    - authServerId
```
String authServerId
```
    - loginAttemptResult
```
String loginAttemptResult
```
    - considered
```
boolean considered
```
    - attemptTime
```
Instant attemptTime
```
Package com.broadleafcommerce.auth.user.service.password
- Class com.broadleafcommerce.auth.user.service.password.AccountLockedException extends Exception implements Serializable
- Class com.broadleafcommerce.auth.user.service.password.ResetPasswordException extends RuntimeException implements Serializable
Package com.broadleafcommerce.auth.user.session
- Class com.broadleafcommerce.auth.user.session.BasicSavedRequest extends Object implements Serializable
  - Serialized Fields
    - redirectUrl
```
String redirectUrl
```
- Class com.broadleafcommerce.auth.user.session.DefaultOAuth2SessionToken extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - value
```
String value
```
    - claims
```
Map<K,V> claims
```
- Class com.broadleafcommerce.auth.user.session.FormLoginAuthenticationToken extends org.springframework.security.authentication.UsernamePasswordAuthenticationToken implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
```
String clientId
```
- Class com.broadleafcommerce.auth.user.session.OAuth2SessionAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
```
String clientId
```
      The OAuth2 client ID.
    - token
```
OAuth2SessionToken token
```
      The JWT token from the BLSID-[client_id] session cookie.
    - principal
```
Object principal
```
      The OAuth2 principal.
Package com.broadleafcommerce.auth.user.session.embedded
- Class com.broadleafcommerce.auth.user.session.embedded.EmbeddedLoginAuthenticationToken extends FormLoginAuthenticationToken implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.broadleafcommerce.auth.user.session.embedded.EmbeddedLoginNotAllowedException extends org.springframework.security.core.AuthenticationException implements Serializable
  - Serialized Fields
    - authServerId
```
String authServerId
```
      ID of the AuthorizationServer that received the request.
    - clientId
```
String clientId
```
      ID of the AuthorizedClient that received the request.
- Class com.broadleafcommerce.auth.user.session.embedded.EmbeddedLoginOTPResponseException extends org.springframework.security.core.AuthenticationException implements Serializable
- Class com.broadleafcommerce.auth.user.session.embedded.EmbeddedLoginTokenEndpointAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
    - username
```
String username
```
    - userId
```
String userId
```
    - scope
```
String scope
```
    - code
```
String code
```
    - purpose
```
String purpose
```
- Class com.broadleafcommerce.auth.user.session.embedded.EmbeddedRegistrationNotAllowedException extends RuntimeException implements Serializable
  - Serialized Fields
    - authServerId
```
String authServerId
```
      ID of the AuthorizationServer that received the request.
    - clientId
```
String clientId
```
      ID of the AuthorizedClient that received the request.
Package com.broadleafcommerce.auth.user.web.endpoint
- Class com.broadleafcommerce.auth.user.web.endpoint.EmbeddedAuthenticationController.PasswordResetEmailRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - username
```
String username
```
      Username of the user trying to reset their password.
Package com.broadleafcommerce.auth.user.web.endpoint.exception
- Class com.broadleafcommerce.auth.user.web.endpoint.exception.ClientValidationException extends RuntimeException implements Serializable
Package com.broadleafcommerce.auth.user.web.endpoint.model
- Class com.broadleafcommerce.auth.user.web.endpoint.model.OAuth2IdentityProvider extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      The registration ID of the of the IDP.
    - name
```
String name
```
      The name of the IDP. This will be displayed to the user.
    - url
```
String url
```
      The action URL to take the user to the authentication page for this IDP.
    - icon
```
String icon
```
      The path to a static resource that represents an icon to display on the action component for this IDP.

Serialized Form

Package com.broadleafcommerce.auth.client.domain

Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails extends Object implements Serializable

Serialized Fields

registrationId

issuerUri

authorizationUri

tokenUri

userInfoEndpoint

jwkSetUri

configurationMetadata

Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails.UserInfoEndpoint extends Object implements Serializable

Serialized Fields

uri

authenticationMethod

userNameAttributeName

Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationWrapper extends Object implements Serializable

Serialized Fields

id

tenantId

registrationId

clientId

clientSecret

clientAuthenticationMethod

authorizationGrantType

redirectUriTemplate

scopes

providerDetails

clientName

Package com.broadleafcommerce.auth.client.provider.authentication

Class com.broadleafcommerce.auth.client.provider.authentication.BroadleafOAuthClientAuthenticationDetails extends Object implements Serializable

Serialized Fields

clientId

Package com.broadleafcommerce.auth.client.provider.jpa.domain

Class com.broadleafcommerce.auth.client.provider.jpa.domain.JpaOAuthClientProviderDetails extends Object implements Serializable

Serialized Fields

id

authorizationUri

tokenUri

jwkSetUri

registrationId

configurationMetadata

userInfoUri

userInfoAuthenticationMethod

userInfoUserNameAttributeName

Class com.broadleafcommerce.auth.client.provider.jpa.domain.JpaOAuthClientRegistration extends Object implements Serializable

Serialized Fields

id

tenantId

registrationId

clientId

clientSecret

clientAuthenticationMethod

authorizationGrantType

redirectUriTemplate

scopes

clientName

providerDetails

Package com.broadleafcommerce.auth.passcode.service

Class com.broadleafcommerce.auth.passcode.service.PasscodeNotConsumedException extends Exception implements Serializable

Package com.broadleafcommerce.auth.resource.domain

Class com.broadleafcommerce.auth.resource.domain.RestrictedPermission extends Object implements Serializable

Serialized Fields

restriction

permission

Class com.broadleafcommerce.auth.resource.domain.RestrictedRole extends Object implements Serializable

Serialized Fields

restriction

role

Class com.broadleafcommerce.auth.resource.domain.Restriction extends Object implements Serializable

Serialized Fields

type

targets

Class com.broadleafcommerce.auth.resource.domain.User extends Object implements Serializable

Serialized Fields

id

firstName

middleName

lastName

fullName