CoreAuthCustomer

Table of Contents

Customer::AuthModule

Defines the module to authenticate customers.

This setting can not be deactivated.

Default value:

Kernel::System::CustomerAuth::DB

Customer::AuthModule::DB::CryptType

If “DB” was selected for Customer::AuthModule, the encryption type of passwords must be specified.

This setting can not be deactivated.

Default value:

sha2

Customer::AuthModule::DB::CustomerKey

If “DB” was selected for Customer::AuthModule, the name of the column for the CustomerKey in the customer table must be specified.

This setting can not be deactivated.

Default value:

login

Customer::AuthModule::DB::CustomerPassword

If “DB” was selected for Customer::AuthModule, the column name for the CustomerPassword in the customer table must be specified.

This setting can not be deactivated.

Default value:

pw

Customer::AuthModule::DB::DSN

If “DB” was selected for Customer::AuthModule, the DSN for the connection to the customer table must be specified.

This setting is not active by default.

Default value:

DBI:mysql:database=customerdb;host=customerdbhost

Customer::AuthModule::DB::Password

If “DB” was selected for Customer::AuthModule, a password to connect to the customer table can be specified.

This setting is not active by default.

Default value:

some_password

Customer::AuthModule::DB::Table

If “DB” was selected for Customer::AuthModule, the name of the table where your customer data should be stored must be specified.

This setting can not be deactivated.

Default value:

customer_user

Customer::AuthModule::DB::Type

If “DB” was selected for Customer::AuthModule, a database driver (normally autodetection is used) can be specified.

This setting is not active by default.

Default value:

mysql

Customer::AuthModule::DB::User

If “DB” was selected for Customer::AuthModule, a username to connect to the customer table can be specified.

This setting is not active by default.

Default value:

some_user

Customer::AuthModule::DB::bcryptCost

If “bcrypt” was selected for CryptType, use cost specified here for bcrypt hashing. Currently max. supported cost value is 31.

This setting can not be deactivated.

Default value:

12

Customer::AuthModule::DB::bcryptType

If “bcrypt” was selected for CryptType, Type specified here sets the subtype of bcrypt used. The available types are: ‘2b’ current standard, ‘2a’ is older; it’s the one used in Crypt::Eksblowfish, ‘2y’ is considered equivalent to 2b and used in PHP. ‘2x’ is very broken and only needed to work with ancient PHP versions.

This setting can not be deactivated.

Default value:

2b

Customer::AuthModule::HTTPBasicAuth::Replace

If “HTTPBasicAuth” was selected for Customer::AuthModule, you can specify to strip leading parts of user names (e. g. for domains like example_domainuser to user).

This setting is not active by default.

Default value:

example_domain\\

Customer::AuthModule::HTTPBasicAuth::ReplaceRegExp

If “HTTPBasicAuth” was selected for Customer::AuthModule, you can specify (by using a RegExp) to strip parts of REMOTE_USER (e. g. for to remove trailing domains). RegExp-Note, $1 will be the new Login.

This setting is not active by default.

Default value:

^(.+?)@.+?$

Customer::AuthModule::LDAP::AccessAttr

If “LDAP” was selected for Customer::AuthModule, you can specify access attributes here.

This setting is not active by default.

Default value:

memberUid

Customer::AuthModule::LDAP::AlwaysFilter

If “LDAP” was selected, you can add a filter to each LDAP query, e.g. (mail=*), (objectclass=user) or (!objectclass=computer).

This setting is not active by default.

Default value:

(!objectclass=computer)

Customer::AuthModule::LDAP::BaseDN

If “LDAP” was selected for Customer::AuthModule, the BaseDN must be specified.

This setting is not active by default.

Default value:

dc=example,dc=com

Customer::AuthModule::LDAP::Die

If “LDAP” was selected for Customer::AuthModule, you can specify if the applications will stop if e. g. a connection to a server can’t be established due to network problems.

Default value:

1

Customer::AuthModule::LDAP::GroupDN

If “LDAP” was selected for Customer::Authmodule, you can check if the user is allowed to authenticate because he is in a posixGroup, e.g. user needs to be in a group xyz to use OTRS. Specify the group, who may access the system.

This setting is not active by default.

Default value:

cn=otrsallow,ou=posixGroups,dc=example,dc=com

Customer::AuthModule::LDAP::Host

If “LDAP” was selected for Customer::AuthModule, the LDAP host can be specified.

This setting is not active by default.

Default value:

ldap.example.com

Customer::AuthModule::LDAP::Params

If “LDAP” was selected for Customer::AuthModule and special paramaters are needed for the Net::LDAP perl module, you can specify them here. See “perldoc Net::LDAP” for more information about the parameters.

This setting is not active by default.

Default value:

---
async: '0'
port: '389'
timeout: '120'
version: '3'

Customer::AuthModule::LDAP::SearchUserDN

If “LDAP” was selected for Customer::AuthModule and your users have only anonymous access to the LDAP tree, but you want to search through the data, you can do this with a user who has access to the LDAP directory. Specify the username for this special user here.

This setting is not active by default.

Default value:

cn=binduser,ou=users,dc=example,dc=com

Customer::AuthModule::LDAP::SearchUserPw

If “LDAP” was selected for Customer::AuthModule and your users have only anonymous access to the LDAP tree, but you want to search through the data, you can do this with a user who has access to the LDAP directory. Specify the password for this special user here.

This setting is not active by default.

Default value:

some_password

Customer::AuthModule::LDAP::UID

If “LDAP” was selected for Customer::AuthModule, the user identifier must be specified.

This setting is not active by default.

Default value:

uid

Customer::AuthModule::LDAP::UserAttr

If “LDAP” was selected for Customer::AuthModule, user attributes can be specified. For LDAP posixGroups use UID, for non LDAP posixGroups use full user DN.

This setting is not active by default.

Default value:

UID

Customer::AuthModule::LDAP::UserSuffix

If “LDAP” was selected for Customer::AuthModule and if you want to add a suffix to every customer login name, specifiy it here, e. g. you just want to write the username user but in your LDAP directory exists user@domain.

This setting is not active by default.

Default value:

@domain.com

Customer::AuthModule::Radius::Die

If “Radius” was selected for Customer::AuthModule, you can specify if the applications will stop if e. g. a connection to a server can’t be established due to network problems.

Default value:

1

Customer::AuthModule::Radius::Host

If “Radius” was selected for Customer::AuthModule, the radius host must be specified.

This setting is not active by default.

Default value:

radiushost

Customer::AuthModule::Radius::Password

If “Radius” was selected for Customer::AuthModule, the password to authenticate to the radius host must be specified.

This setting is not active by default.

Default value:

radiussecret

Customer::AuthPostAuthModule###1000-PasswordChange

Defines the password change post authentication module.

This setting can not be deactivated.

Default value:

Kernel::System::CustomerAuth::PostAuth::PasswordChange

Customer::AuthPostAuthModule###2000-TwoFactorSetup

Defines the password change post authentication module.

This setting can not be deactivated.

Default value:

Kernel::System::CustomerAuth::PostAuth::TwoFactorSetup

Customer::DefaultUserID

Defines the (agent) user identifier for actions triggered by customers.

This setting can not be deactivated.

Default value:

1

CustomerDisableCompanyTicketAccess

This option will deny the access to customer company tickets, which are not created by the customer user.

This setting can not be deactivated.

Default value:

0

CustomerGroupAlwaysGroups

Defines the groups every customer user will be in (if CustomerGroupSupport is enabled and you don’t want to manage every customer user for these groups).

This setting can not be deactivated.

Default value:

---
- users

CustomerGroupCompanyAlwaysGroups

Defines the groups every customer will be in (if CustomerGroupSupport is enabled and you don’t want to manage every customer for these groups).

This setting can not be deactivated.

Default value:

---
- users

CustomerGroupPermissionContext###001-CustomerID-same

Defines a permission context for customer to group assignment.

This setting can not be deactivated.

Default value:

---
Description: Gives customer users group based access to tickets from customer users
  of the same customer (ticket CustomerID is a CustomerID of the customer user).
Name: Same Customer
Value: Ticket::CustomerID::Same

CustomerGroupPermissionContext###100-CustomerID-other

Defines a permission context for customer to group assignment.

This setting is not active by default.

Default value:

---
Description: Provides customer users access to tickets even if the tickets are not
  assigned to a customer user of the same customer ID(s), based on permission groups.
Name: Other Customers
Value: Ticket::CustomerID::Other

CustomerGroupSupport

Activates support for customer and customer user groups.

This setting can not be deactivated.

Default value:

0

CustomerPreferences

Defines the parameters for the customer preferences table.

This setting can not be deactivated.

Default value:

---
Module: Kernel::System::CustomerUser::Preferences::DB
Params:
  Table: customer_preferences
  TableKey: preferences_key
  TableUserID: user_id
  TableValue: preferences_value

AgentFrontend::Customer::TicketKPI###0001-Framework

Definition of KPI for the customer company.

Default value:

---
- Active: '1'
  AriaLabel: Open tickets for customer
  Attributes: StateType=Open;
  Module: Kernel::WebApp::Util::KPI::Ticket
  Name: OpenTickets
  Title: Open Tickets
  TotalsActive: '1'
  TotalsAttributes: ''
  TotalsTitle: Total Tickets
  TotalsURLConfig: ''
  URL: /tickets/static
  URLConfig:
    FilterPresetSelected: Open Tickets
    FilterPresets:
      Open Tickets:
        StateType:
          Value: Open
- Active: '1'
  AriaLabel: Closed tickets for customer
  Attributes: StateType=Closed;
  Module: Kernel::WebApp::Util::KPI::Ticket
  Name: ClosedTickets
  Title: Closed Tickets
  TotalsActive: '1'
  TotalsAttributes: ''
  TotalsTitle: Total Tickets
  TotalsURLConfig: ''
  URL: /tickets/static
  URLConfig:
    FilterPresetSelected: Closed Tickets
    FilterPresets:
      Closed Tickets:
        StateType:
          Value: Closed

AgentFrontend::Customer::TicketKPI###4001-Custom

Definition of KPI for the customer company.

This setting is not active by default.

Default value:

--- []

Forms###AgentFrontend::Ticket::Action::Customer

Configurable form for the Change Customer action.

This setting can not be deactivated.

Default value:

---
- Collapsible: 1
  Fields:
  - Name: CustomerUserID
  - Disabled: 1
    Name: CustomerID
  Label: Change Customer

WebApp::API::Customer::DefaultAgentName

Defines the default agent name in the ticket detail view of the external interface.

This setting can not be deactivated.

Default value:

Support Agent

WebApp::API::Customer::DisplayAgentCustomAvatar

Enables or disables the output of the custom agent avatar in the ticket detail view (if this is disabled, the fallback to the default avatar image is active).

This setting can not be deactivated.

Default value:

1

WebApp::API::Customer::DisplayNoteFrom

Defines the displayed style of the From field in notes that are visible to customers. A default agent name can be defined in WebApp::API::Customer::DefaultAgentName setting.

This setting can not be deactivated.

Default value:

FromField
Scroll to Top