← Back to plugin index

Basic Auth Request Authentication

Description
Authenticates single requests with HTTP Basic Authentication.
Type name
BasicAuthRequestAuthentication
Class
com.airlock.iam.common.application.configuration.credential.BasicAuthRequestAuthenticationConfig
May be used by
Properties
Password Repository (passwordRepository)
Description
The repository of user passwords.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Policy To Check On Login (policyToCheckOnLogin)
Description
The password policy that is checked when authenticating. Authentication fails if password policies are violated.
Attributes
Plugin-Link
Optional
Assignable plugins
Max Failed Attempts (maxFailedAttempts)
Description
The maximum number of failed authentication attempts before the user is locked.

Effective only if a 'User Store' is configured.

Attributes
Integer
Optional
Default value
5
Charset Name (charsetName)
Description
The character set to use for decoding 'Authorization' headers.
Attributes
String
Optional
Default value
UTF-8
Suggested values
ISO-8859-1, UTF-8
User Store (userStore)
Description
If configured, the user is loaded from local persistence and checked for validity. Authentication fails if the user is not found or is invalid. If no user store is configured, no persistency look-up takes place and the authentication is performed on data contained within the credential only.
Attributes
Plugin-Link
Optional
Assignable plugins
Username Transformation (usernameTransformers)
Description
Transforms the provided username from the credential to a technical user ID.
Attributes
Plugin-List
Optional
Assignable plugins
Static Roles (staticRoles)
Description
Static list of roles granted to the authenticated user.
Attributes
String-List
Optional
Roles Blocklist (rolesBlocklist)
Description
List of role names that won't be granted to the authenticated user. The block list is also applied to persistent roles (if available).
Attributes
String-List
Optional
YAML Template (with default values)

type: BasicAuthRequestAuthentication
id: BasicAuthRequestAuthentication-xxxxxx
displayName: 
comment: 
properties:
  charsetName: UTF-8
  maxFailedAttempts: 5
  passwordRepository:
  policyToCheckOnLogin:
  rolesBlocklist:
  staticRoles:
  userStore:
  usernameTransformers: