Serialized Form (Broadleaf Authentication Services 1.7.1-GA API)

Package com.broadleafcommerce.auth.client.domain
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - authorizationUri
      
      String authorizationUri
      
      See Also:
      
      ClientRegistration.ProviderDetails.getAuthorizationUri()
    - configurationMetadata
      
      Map<String,Object> configurationMetadata
      
      See Also:
      
      ClientRegistration.ProviderDetails.getConfigurationMetadata()
    - 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.
    - jwkSetUri
      
      String jwkSetUri
      
      See Also:
      
      ClientRegistration.ProviderDetails.getJwkSetUri()
    - registrationId
      
      String registrationId
      
      The ID of the registered provider. Should match OAuthClientRegistrationWrapper.getRegistrationId().
    - tokenUri
      
      String tokenUri
      
      See Also:
      
      ClientRegistration.ProviderDetails.getTokenUri()
    - userInfoEndpoint
      
      OAuthClientRegistrationProviderDetails.UserInfoEndpoint userInfoEndpoint
      
      See Also:
      
      ClientRegistration.ProviderDetails.getUserInfoEndpoint()
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationProviderDetails.UserInfoEndpoint extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - authenticationMethod
      
      String authenticationMethod
      
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint.getAuthenticationMethod()
    - uri
      
      String uri
      
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint.getUri()
    - userNameAttributeName
      
      String userNameAttributeName
      
      See Also:
      
      ClientRegistration.ProviderDetails.UserInfoEndpoint.getUserNameAttributeName()
- Class com.broadleafcommerce.auth.client.domain.OAuthClientRegistrationWrapper extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - authorizationGrantType
      
      String authorizationGrantType
      
      See Also:
      
      ClientRegistration.getAuthorizationGrantType()
    - clientAuthenticationMethod
      
      String clientAuthenticationMethod
      
      See Also:
      
      ClientRegistration.getClientAuthenticationMethod()
    - clientId
      
      String clientId
      
      See Also:
      
      ClientRegistration.getClientId()
    - clientName
      
      String clientName
      
      See Also:
      
      ClientRegistration.getClientName()
    - clientSecret
      
      String clientSecret
      
      See Also:
      
      ClientRegistration.getClientSecret()
    - id
      
      String id
      
      The system ID of the registration
    - providerDetails
      
      OAuthClientRegistrationProviderDetails providerDetails
      
      See Also:
      
      ClientRegistration.getProviderDetails(), OAuthClientRegistrationProviderDetails
    - redirectUriTemplate
      
      String redirectUriTemplate
      
      See Also:
      
      ClientRegistration.getRedirectUriTemplate()
    - registrationId
      
      String registrationId
      
      See Also:
      
      ClientRegistration.getRegistrationId()
    - scopes
      
      Set<String> scopes
      
      See Also:
      
      ClientRegistration.getScopes()
    - 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).
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
    - authorizationUri
      
      String authorizationUri
    - configurationMetadata
      
      Map<String,Object> configurationMetadata
    - id
      
      String id
    - jwkSetUri
      
      String jwkSetUri
    - registrationId
      
      String registrationId
    - tokenUri
      
      String tokenUri
    - userInfoAuthenticationMethod
      
      String userInfoAuthenticationMethod
    - userInfoUri
      
      String userInfoUri
    - userInfoUserNameAttributeName
      
      String userInfoUserNameAttributeName
- Class com.broadleafcommerce.auth.client.provider.jpa.domain.JpaOAuthClientRegistration extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - authorizationGrantType
      
      String authorizationGrantType
    - clientAuthenticationMethod
      
      String clientAuthenticationMethod
    - clientId
      
      String clientId
    - clientName
      
      String clientName
    - clientSecret
      
      String clientSecret
    - id
      
      String id
    - providerDetails
      
      JpaOAuthClientProviderDetails providerDetails
    - redirectUriTemplate
      
      String redirectUriTemplate
    - registrationId
      
      String registrationId
    - scopes
      
      Set<String> scopes
    - tenantId
      
      String tenantId
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
    - permission
      
      UserPermissionRef permission
      
      Represents the permission that is being restricted.
    - restriction
      
      Restriction restriction
      
      Represents the restriction on this permission.
- 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
    - targets
      
      Set<String> targets
      
      Represents the targets of the restriction.
    - type
      
      String type
      
      Represents the type of the restriction.
- Class com.broadleafcommerce.auth.resource.domain.User extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized 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.
    - 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.
    - applicationIds
      
      Set<String> 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.
    - 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.
    - attributes
      
      Map<String,Object> 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.
    - 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.
    - 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.
    - email
      
      String email
      
      The user's email address.
    - 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.
    - 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.
    - firstName
      
      String firstName
      
      The first 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.
    - id
      
      String id
    - impersonationAllowed
      
      boolean impersonationAllowed
      
      A flag indicated whether or not this user is allowed to be impersonated.
    - lastName
      
      String lastName
      
      The last name of the user, if the fullName is not being used for the user.
    - lastUpdated
      
      Instant lastUpdated
      
      Indicates when this record was last updated.
    - 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.
    - lockedTime
      
      Instant lockedTime
      
      If this user is locked out, the time that the user was locked.
    - middleName
      
      String middleName
      
      The middle name of the user, if the fullName is not being used for the user.
    - permissions
      
      Set<UserPermissionRef> permissions
      
      The permissions that this user is directly assigned (in addition to permissions granted through User.roles).
    - restrictedPermissions
      
      Set<RestrictedPermission> restrictedPermissions
      
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictedRoles
      
      Set<RestrictedRole> restrictedRoles
      
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictions
      
      Set<Restriction> restrictions
      
      The data restrictions that control the data this user is permitted to access.
    - roles
      
      Set<UserRoleRef> 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.
    - serverId
      
      String serverId
      
      The ID of the authorization server that this user is a member of.
    - 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
    - tenantAccess
      
      boolean tenantAccess
      
      Indicates whether this user has access at the tenant level or not.
      This field only applies to UserType.ADMIN users.
    - tenantId
      
      String tenantId
      
      The id of the tenant this user is associated with.
    - 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
    - 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.
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
    - archived
      
      boolean archived
      
      See Also:
      
      UserPermission.archived
    - id
      
      String id
    - 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
    - name
      
      String name
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestrictedPermission extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
      
      String id
    - permission
      
      JpaUserPermission permission
    - restrictionTargets
      
      Set<String> restrictionTargets
    - restrictionType
      
      String restrictionType
    - user
      
      JpaUser user
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestrictedRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
      
      String id
    - restrictionTargets
      
      Set<String> restrictionTargets
    - restrictionType
      
      String restrictionType
    - role
      
      JpaUserRole role
    - user
      
      JpaUser user
- Class com.broadleafcommerce.auth.security.domain.JpaUserRestriction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
      
      String id
    - restrictionTargets
      
      Set<String> restrictionTargets
    - restrictionType
      
      String restrictionType
    - user
      
      JpaUser user
- Class com.broadleafcommerce.auth.security.domain.JpaUserRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - archived
      
      boolean archived
      
      See Also:
      
      UserRole.archived
    - id
      
      String id
    - 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
    - name
      
      String name
    - parentRoleId
      
      String parentRoleId
      
      A soft reference to the parent of this role.
      
      See Also:
      
      UserRole.parentRoleId
    - permissions
      
      Set<JpaUserPermission> permissions
- Class com.broadleafcommerce.auth.security.domain.PermissionScope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
      
      String id
    - 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.
    - scope
      
      SecurityScope scope
- 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
    - 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<String,Object> attributes
      
      Additional attributes for this client, not needed by the vanilla OAuth protocol but might be useful, for example, for storing descriptive information.
    - clientId
      
      String clientId
      
      The OAuth2 client ID for this authorized client. Usually generated as a randomized string.
    - defaultRedirectUri
      
      String defaultRedirectUri
      
      The default redirect URI to use if a user accesses a login page without a valid redirect cookie
    - friendlyName
      
      String friendlyName
      
      The friendly name of this authorized client. Intended for display purposes
    - grantTypes
      
      Set<String> grantTypes
      
      The grant types for which this client is authorized.
    - id
      
      String id
      
      The primary key of this authorized client.
    - 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.
    - permissions
      
      Set<String> 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.
    - redirectUris
      
      Set<String> 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
    - 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<String> resourceIds
      
      The resources that this client can access. Can be ignored by callers if empty.
    - scopes
      
      Set<String> scopes
      
      The scopes for this client. Empty if the client isn't scoped.
    - serverId
      
      String serverId
      
      The ID of the authorization server this authorized client is part of.
    - tokenTimeoutSeconds
      
      Integer tokenTimeoutSeconds
      
      The period of time, in seconds, that an access token issued will be valid for.
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
    - attributes
      
      Map<String,Object> attributes
    - crossOrigin
      
      boolean crossOrigin
    - defaultRedirectUri
      
      String defaultRedirectUri
    - defaultUserPermissions
      
      Set<JpaUserPermission> defaultUserPermissions
    - defaultUserRoles
      
      Set<JpaUserRole> defaultUserRoles
    - embeddedLoginEnabled
      
      boolean embeddedLoginEnabled
    - failedLoginAttemptsAllowed
      
      Integer failedLoginAttemptsAllowed
    - friendlyName
      
      String friendlyName
    - id
      
      String id
    - inactivityTimeoutSeconds
      
      Integer inactivityTimeoutSeconds
    - lockedUserCanResetPassword
      
      Boolean lockedUserCanResetPassword
    - lockoutDurationMinutes
      
      Long lockoutDurationMinutes
    - loginFailDecayMinutes
      
      Long loginFailDecayMinutes
    - name
      
      String name
    - requireLoginTimeoutSeconds
      
      Integer requireLoginTimeoutSeconds
    - resetPasswordUnlocksUser
      
      Boolean resetPasswordUnlocksUser
    - ssoEnabled
      
      boolean ssoEnabled
    - templatePath
      
      String templatePath
    - tenantId
      
      String tenantId
- Class com.broadleafcommerce.auth.server.provider.jpa.domain.JpaAuthorizedClient extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - applicationId
      
      String applicationId
    - attributes
      
      Map<String,Object> attributes
    - clientId
      
      String clientId
    - clientSecret
      
      String clientSecret
    - defaultRedirectUri
      
      String defaultRedirectUri
    - friendlyName
      
      String friendlyName
    - grantTypes
      
      Set<String> grantTypes
    - id
      
      String id
    - isAdmin
      
      boolean isAdmin
    - permissions
      
      Set<String> permissions
    - redirectUris
      
      Set<String> redirectUris
    - refreshTokenRotationIntervalSeconds
      
      Integer refreshTokenRotationIntervalSeconds
    - refreshTokenTimeoutSeconds
      
      Integer refreshTokenTimeoutSeconds
    - resourceIds
      
      Set<String> resourceIds
    - scopes
      
      Set<String> scopes
    - serverId
      
      String serverId
    - tokenTimeoutSeconds
      
      int tokenTimeoutSeconds
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
    - customerContextId
      
      String customerContextId
      
      See Also:
      
      Application.getCustomerContextId()
    - deactivated
      
      boolean deactivated
      
      See Also:
      
      Application.isDeactivated()
    - id
      
      String id
      
      See Also:
      
      Application.getId()
    - identifierType
      
      String identifierType
      
      See Also:
      
      Application.getIdentifierType()
    - identifierValue
      
      String identifierValue
      
      See Also:
      
      Application.getIdentifierValue()
    - isMarketplace
      
      boolean isMarketplace
      
      See Also:
      
      Application.isMarketplace()
    - 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
    - tenantId
      
      String tenantId
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
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken2 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken3 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken4 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken5 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
- Class com.broadleafcommerce.auth.token.provider.jpa.domain.JpaRefreshToken6 extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ancestor
      
      String ancestor
    - expiration
      
      Long expiration
    - id
      
      String id
    - isRotated
      
      boolean isRotated
    - rotationExpiration
      
      Long rotationExpiration
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
    - client_id
      
      String client_id
    - currentPassword
      
      String currentPassword
    - newPassword
      
      String newPassword
    - newPasswordConfirm
      
      String newPasswordConfirm
- Class com.broadleafcommerce.auth.user.api.dto.ResetPasswordForm extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - client_id
      
      String client_id
    - password
      
      String password
    - token
      
      String token
    - username
      
      String username
Package com.broadleafcommerce.auth.user.domain
- Class com.broadleafcommerce.auth.user.domain.AuthenticationEvent extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attributes
      
      Map<String,Object> 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.
    - messageType
      
      String messageType
      
      The message type for this event.
      
      See Also:
      
      AuthenticationMessageType
    - user
      
      User user
      
      The user that made the request
- Class com.broadleafcommerce.auth.user.domain.DefaultOAuth2UserDetails extends org.springframework.security.core.userdetails.User implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
      
      String clientId
    - id
      
      String id
    - impersonationAllowed
      
      boolean impersonationAllowed
    - restrictedAuthorities
      
      Map<String,Map<String,Set<String>>> restrictedAuthorities
    - restrictions
      
      Map<String,Set<String>> restrictions
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_client_id
      
      String impersonated_client_id
    - impersonated_sub
      
      String impersonated_sub
    - 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
    - businessDomainType
      
      String businessDomainType
    - id
      
      String id
    - name
      
      String name
    - tenantId
      
      String tenantId
- 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
      
      String permission
      
      The id of the permission that is being restricted.
    - restrictionTargets
      
      Set<String> restrictionTargets
      
      Represents the targets of the restriction.
    - restrictionType
      
      String restrictionType
      
      Represents the type of the restriction.
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRestrictedRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - restrictionTargets
      
      Set<String> restrictionTargets
      
      Represents the targets of the restriction.
    - restrictionType
      
      String restrictionType
      
      Represents the type of the restriction.
    - role
      
      String role
      
      id of the role that is being restricted.
- 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.
    - restrictionTargets
      
      Set<String> restrictionTargets
      
      Represents the targets of the restriction.
    - restrictionType
      
      String restrictionType
      
      Represents the type of the restriction.
- Class com.broadleafcommerce.auth.user.listener.domain.AdminRole extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - businessDomainType
      
      String businessDomainType
    - id
      
      String id
    - name
      
      String name
    - parentRoleId
      
      String parentRoleId
    - permissions
      
      Set<AdminPermissionRef> permissions
    - tenantId
      
      String tenantId
- 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
    - active
      
      boolean active
    - applicationAccess
      
      boolean applicationAccess
    - applicationIds
      
      Set<String> applicationIds
    - businessDomainType
      
      String businessDomainType
    - changePasswordRequired
      
      boolean changePasswordRequired
    - email
      
      String email
    - expired
      
      boolean expired
    - id
      
      String id
    - locked
      
      boolean locked
    - name
      
      String name
    - permissionIds
      
      Set<String> permissionIds
    - permissions
      
      Set<AdminPermissionRef> permissions
      
      Deprecated.
    - restrictedPermissions
      
      Set<AdminRestrictedPermission> restrictedPermissions
      
      The permissions that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictedRoles
      
      Set<AdminRestrictedRole> restrictedRoles
      
      The roles that this user is directly assigned that are restricted to only apply when accessing certain segments of data.
    - restrictions
      
      Set<AdminRestriction> restrictions
      
      The data restrictions that control the data this user is permitted to access.
    - roleIds
      
      Set<String> roleIds
    - roles
      
      Set<AdminRoleRef> roles
      
      Deprecated.
    - tenantAccess
      
      boolean tenantAccess
    - tenantId
      
      String tenantId
    - username
      
      String username
Package com.broadleafcommerce.auth.user.messaging
- Class com.broadleafcommerce.auth.user.messaging.UserCreationEvent extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attributes
      
      Map<String,Object> 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
    - preview
      
      boolean preview
      
      Indicates whether the user was created from a preview context.
    - user
      
      User user
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
    - dateCreated
      
      Instant dateCreated
    - dateUsed
      
      Instant dateUsed
    - id
      
      String id
    - purpose
      
      String purpose
    - token
      
      String token
    - used
      
      boolean used
    - userId
      
      String userId
- Class com.broadleafcommerce.auth.user.provider.jpa.domain.JpaUser extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - active
      
      boolean active
      
      See Also:
      
      User.active
    - applicationAccess
      
      boolean applicationAccess
      
      See Also:
      
      User.applicationAccess
    - applicationIds
      
      Set<String> applicationIds
      
      See Also:
      
      User.applicationIds
    - archived
      
      boolean archived
      
      See Also:
      
      User.archived
    - attributes
      
      Map<String,Object> attributes
      
      See Also:
      
      User.attributes
    - changePasswordRequired
      
      boolean changePasswordRequired
      
      See Also:
      
      User.changePasswordRequired
    - customerContextId
      
      String customerContextId
      
      See Also:
      
      User.customerContextId
    - email
      
      String email
      
      See Also:
      
      User.email
    - expired
      
      boolean expired
      
      See Also:
      
      User.expired
    - externalId
      
      String externalId
      
      See Also:
      
      User.externalId
    - firstName
      
      String firstName
      
      See Also:
      
      User.firstName
    - fullName
      
      String fullName
      
      See Also:
      
      User.fullName
    - id
      
      String id
    - impersonationAllowed
      
      boolean impersonationAllowed
      
      See Also:
      
      User.impersonationAllowed
    - lastName
      
      String lastName
      
      See Also:
      
      User.lastName
    - 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
    - locked
      
      boolean locked
      
      See Also:
      
      User.locked
    - lockedTime
      
      Instant lockedTime
    - middleName
      
      String middleName
      
      See Also:
      
      User.middleName
    - password
      
      String password
      
      See Also:
      
      User.password
    - permissions
      
      Set<JpaUserPermission> permissions
      
      See Also:
      
      User.permissions
    - restrictedPermissions
      
      Set<JpaUserRestrictedPermission> restrictedPermissions
      
      See Also:
      
      User.restrictedPermissions
    - restrictedRoles
      
      Set<JpaUserRestrictedRole> restrictedRoles
      
      See Also:
      
      User.restrictedRoles
    - restrictions
      
      Set<JpaUserRestriction> restrictions
      
      See Also:
      
      User.restrictions
    - roles
      
      Set<JpaUserRole> roles
      
      See Also:
      
      User.roles
    - serverId
      
      String serverId
      
      See Also:
      
      User.serverId
    - serviceId
      
      String serviceId
      
      See Also:
      
      User.serviceId
    - tenantAccess
      
      boolean tenantAccess
      
      See Also:
      
      User.tenantAccess
    - tenantId
      
      String tenantId
      
      See Also:
      
      User.tenantId
    - type
      
      String type
      
      See Also:
      
      User.type
    - username
      
      String username
      
      See Also:
      
      User.username
- Class com.broadleafcommerce.auth.user.provider.jpa.domain.JpaUserLoginAttempt extends Object implements Serializable
  - Serialized Fields
    - attemptTime
      
      Instant attemptTime
    - authServerId
      
      String authServerId
    - considered
      
      boolean considered
    - id
      
      String id
    - loginAttemptResult
      
      String loginAttemptResult
    - userId
      
      String userId
    - username
      
      String username
      
      The username used in the login attempt. Required.
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
    - claims
      
      Map<String,Object> claims
    - value
      
      String value
- 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.
    - principal
      
      Object principal
      
      The OAuth2 principal.
    - token
      
      OAuth2SessionToken token
      
      The JWT token from the BLSID-[client_id] session cookie.
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
    - code
      
      String code
    - purpose
      
      String purpose
    - scope
      
      String scope
    - userId
      
      String userId
    - username
      
      String username
- 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
    - icon
      
      String icon
      
      The path to a static resource that represents an icon to display on the action component for this IDP.
    - 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.

Serialized Form

Package com.broadleafcommerce.auth.client.domain

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

Serialized Fields

authorizationUri

configurationMetadata

issuerUri

jwkSetUri

registrationId

tokenUri

userInfoEndpoint

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

Serialized Fields

authenticationMethod

uri

userNameAttributeName

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

Serialized Fields

authorizationGrantType

clientAuthenticationMethod

clientId

clientName

clientSecret

id

providerDetails

redirectUriTemplate

registrationId

scopes

tenantId

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

authorizationUri

configurationMetadata

id

jwkSetUri

registrationId

tokenUri

userInfoAuthenticationMethod

userInfoUri

userInfoUserNameAttributeName

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

Serialized Fields

authorizationGrantType

clientAuthenticationMethod

clientId

clientName

clientSecret

id

providerDetails

redirectUriTemplate

registrationId

scopes

tenantId

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

permission

restriction

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

targets

type

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

Serialized Fields

active

applicationAccess

applicationIds

archived

attributes