Global services configuration
Under Configure > Global Services, you can set defaults for a range of AM services.
Audit logging
amster service name: audit
Global attributes
The following settings appear on the Global Attributes tab:
- Audit logging
-
Enable audit logging in AM.
Default value:
trueamsterattribute:auditEnabled - Field whitelist filters
-
AM has a predefined allowlist that only records values that do not contain sensitive information. Use this property to allowlist fields in addition to the built-in list.
Each field filter should be provided using a JSON Pointer-like syntax which is prefixed with the event’s topic. The topic will be one of
access,activity,authentication, orconfig.For example, to record the values of the
Accept-LanguageHTTP header in access events, the pointer is/access/http/request/headers/accept-language.amsterattribute:whitelistFieldFilters - Field blacklist filters
-
Denylist filters can be used to remove audit event fields which are allowlisted by default. These are fields which are safe to log but which you have decided are not necessary for your requirements.
Each field filter should be provided using a JSON Pointer-like syntax which is prefixed with the event’s topic. The topic will be one of
access,activity,authentication, orconfig.For example, you might want to filter out surnames by hiding the
snfield from activity events. To do so, add the following pointers to the Field blacklist filters list:-
/activity/before/sn -
/activity/after/sn
amsterattribute:blacklistFieldFilters -
Realm defaults
The following settings appear on the Realm Defaults tab:
- Audit logging
-
Enable audit logging in AM.
Default value:
trueamsterattribute:auditEnabled - Field whitelist filters
-
AM has a predefined allowlist that only records values that do not contain sensitive information. Use this property to allowlist fields in addition to the built-in list.
Each field filter should be provided using a JSON Pointer-like syntax which is prefixed with the event’s topic. The topic will be one of
access,activity,authentication, orconfig.For example, to record the values of the
Accept-LanguageHTTP header in access events, the pointer is/access/http/request/headers/accept-language.amsterattribute:whitelistFieldFilters - Field blacklist filters
-
Denylist filters can be used to remove audit event fields which are allowlisted by default. These are fields which are safe to log but which you have decided are not necessary for your requirements.
Each field filter should be provided using a JSON Pointer-like syntax which is prefixed with the event’s topic. The topic will be one of
access,activity,authentication, orconfig.For example, you might want to filter out surnames by hiding the
snfield from activity events. To do so, add the following pointers to the Field blacklist filters list:-
/activity/before/sn -
/activity/after/sn
amsterattribute:blacklistFieldFilters -
Secondary configurations
This service has the following secondary configurations.
JMS
A configured secondary instance of the JMS type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.JmsAuditEventHandlerFactoryamsterattribute:handlerFactory
JMS configuration
The JMS Configuration tab contains the following secondary configuration properties:
- Delivery Mode
-
Specifies whether JMS messages used to transmit audit events use persistent or non-persistent delivery.
With persistent delivery, the JMS provider ensures that messages are not lost in transit in case of a provider failure by logging messages to storage when they are sent.
Specify the delivery mode as persistent if it is unacceptable for delivery of audit events to be lost in JMS transit. If the possible loss of audit events is acceptable, choose non-persistent delivery, which provides better performance.
Default value:
NON_PERSISTENTamsterattribute:deliveryMode - Session Mode
-
Specifies the JMS session acknowledgement mode.
The following values are supported:
-
AUTO. Auto mode guarantees once-only delivery of JMS messages used to transmit audit events. -
CLIENT. Client mode does not ensure delivery. -
DUPS_OK. Duplicates OK mode ensures that messages are delivered at least once.
Use the default setting unless your JMS broker implementation requires otherwise. See your broker documentation for more information.
Default value:
AUTOamsterattribute:sessionMode -
- JNDI Context Properties
-
Specifies JNDI properties that AM uses to connect to the JMS message broker to which AM will publish audit events.
AM acts as a JMS client, using a JMS connection factory to connect to your JMS message broker. In order for AM to connect to the broker, the JNDI context properties must conform to those needed by the broker. See the documentation for your JMS message broker for required values.
The default properties are example properties for connecting to Apache ActiveMQ.
Default value:
{ "java.naming.factory.initial": "org.apache.activemq.jndi.ActiveMQInitialContextFactory", "topic.audit": "audit", "java.naming.provider.url": "tcp://localhost:61616" }amsterattribute:jndiContextProperties - JMS Topic Name
-
JNDI lookup name for the JMS topic
Default value:
auditamsterattribute:jndiTopicName - JMS Connection Factory Name
-
Specifies the JNDI lookup name for the connection factory exposed by your JMS message broker. AM performs a JNDI lookup on this name to locate your broker’s connection factory.
See the documentation for your JMS message broker for the required value.
The default is the connection factory name for Apache ActiveMQ.
Default value:
ConnectionFactoryamsterattribute:jndiConnectionFactoryName
Batch events
The Batch Events tab contains the following secondary configuration properties:
- Capacity
-
Maximum event count in the batch queue; additional events are dropped.
Default value:
1000amsterattribute:batchCapacity - Max Batched
-
Maximum number of events per batch.
Default value:
100amsterattribute:maxBatchedEvents - Writing Interval
-
The interval (in seconds) for reading events from the buffer to transmit via jms.
Default value:
10amsterattribute:pollTimeoutSec
JSONStdout
A configured secondary instance of the JSONStdout type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.JsonStdoutAuditEventHandlerFactoryamsterattribute:handlerFactory
Elasticsearch
A configured secondary instance of the Elasticsearch type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.ElasticsearchAuditEventHandlerFactoryamsterattribute:handlerFactory
Elasticsearch configuration
The Elasticsearch Configuration tab contains the following secondary configuration properties:
- Server Hostname
-
Host name or IP address of the Elasticsearch server.
amsterattribute:host - Server Port
-
Specifies the port number used to access Elasticsearch’s REST API.
amsterattribute:port - SSL Enabled
-
Specifies whether SSL is configured on the Elasticsearch server.
If SSL is enabled, be sure to import the CA certificate used to sign Elasticsearch node certificates into the Java keystore on the host that runs AM before attempting to log audit events to Elasticsearch.
Default value:
falseamsterattribute:sslEnabled - Elasticsearch Index
-
Specifies the name of the Elasticsearch index to be used for AM audit logging.
amsterattribute:index
Authentication
The Authentication tab contains the following secondary configuration properties:
- Username
-
Specifies the username to access the Elasticsearch server.
Required if Elasticsearch Shield authentication is configured.
amsterattribute:username - Password
-
Specifies the password to access the Elasticsearch server.
Required if Elasticsearch Shield authentication is configured.
amsterattribute:password
Buffering
The Buffering tab contains the following secondary configuration properties:
- Buffering Enabled
-
Default value:
trueamsterattribute:bufferingEnabled - Batch Size
-
Maximum number of events that can be buffered (default: 10000)
Default value:
500amsterattribute:batchSize - Queue Capacity
-
Maximum number of audit logs in the batch queue. Additional audit events are dropped.
Default value:
10000amsterattribute:maxEvents - Write interval (in milliseconds)
-
Specifies the interval in milliseconds at which buffered events are written to Elasticsearch.
Default value:
250amsterattribute:writeInterval
Syslog
A configured secondary instance of the Syslog type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.SyslogAuditEventHandlerFactoryamsterattribute:handlerFactory
Syslog configuration
The Syslog Configuration tab contains the following secondary configuration properties:
- Server hostname
-
Host name or IP address of receiving syslog server.
amsterattribute:host - Server port
-
Port number of receiving syslog server.
amsterattribute:port - Transport Protocol
-
Default value:
TCPamsterattribute:transportProtocol - Connection timeout
-
Timeout for connecting to syslog server, in seconds.
amsterattribute:connectTimeout - Facility
-
Syslog facility value to apply to all events.
Default value:
USERamsterattribute:facility
Buffering
The Buffering tab contains the following secondary configuration properties:
- Buffering Enabled
-
Enables or disables audit event buffering.
Default value:
trueamsterattribute:bufferingEnabled - Buffer Size
-
Maximum number of events that can be buffered (default/minimum: 5000)
Default value:
5000amsterattribute:bufferingMaxSize
CSV
A configured secondary instance of the CSV type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.CsvAuditEventHandlerFactoryamsterattribute:handlerFactory
CSV configuration
The CSV Configuration tab contains the following secondary configuration properties:
- Log Directory
-
Directory in which to store audit log CSV files.
Default value:
%BASE_DIR%/var/audit/amsterattribute:location
File rotation
The File Rotation tab contains the following secondary configuration properties:
- Rotation Enabled
-
Enables and disables audit file rotation.
Default value:
trueamsterattribute:rotationEnabled - Maximum File Size
-
Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.
Default value:
100000000amsterattribute:rotationMaxFileSize - File Rotation Prefix
-
Prefix to prepend to audit files when rotating audit files.
amsterattribute:rotationFilePrefix - File Rotation Suffix
-
Suffix to append to audit files when they are rotated. Suffix should be a timestamp.
Default value:
-yyyy.MM.dd-HH.mm.ssamsterattribute:rotationFileSuffix - Rotation Interval
-
Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.
Default value:
-1amsterattribute:rotationInterval - Rotation Times
-
Durations after midnight to trigger file rotation, in seconds.
amsterattribute:rotationTimes
File retention
The File Retention tab contains the following secondary configuration properties:
- Maximum Number of Historical Files
-
Maximum number of backup audit files allowed. A value of
-1disables pruning of old history files.Default value:
1amsterattribute:retentionMaxNumberOfHistoryFiles - Maximum Disk Space
-
The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.
Default value:
-1amsterattribute:retentionMaxDiskSpaceToUse - Minimum Free Space Required
-
Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.
Default value:
-1amsterattribute:retentionMinFreeSpaceRequired
Buffering
The Buffering tab contains the following secondary configuration properties:
- Buffering Enabled
-
Enables or disables buffering.
Default value:
trueamsterattribute:bufferingEnabled - Flush Each Event Immediately
-
Performance may be improved by writing all buffered events before flushing.
Default value:
falseamsterattribute:bufferingAutoFlush
Tamper Evident Configuration
The Tamper Evident Configuration tab contains the following secondary configuration properties:
- Is Enabled
-
Enables the CSV tamper evident feature.
Default value:
falseamsterattribute:securityEnabled - Certificate Store Location
-
Path to Java keystore.
Default value:
%BASE_DIR%/var/audit/Logger.jksamsterattribute:securityFilename - Certificate Store Password
-
Password for Java keystore.
amsterattribute:securityPassword - Signature Interval
-
Signature generation interval, in seconds.
Default value:
900amsterattribute:securitySignatureInterval
JDBC
A configured secondary instance of the JDBC type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.JdbcAuditEventHandlerFactoryamsterattribute:handlerFactory
Database Configuration
The Database Configuration tab contains the following secondary configuration properties:
- Database Type
-
Select the database to use for logging audit events.
Identifies the database in use, for example MySQL, Oracle, or SQL.
Default value:
oracleamsterattribute:databaseType - JDBC Database URL
-
URL of the JDBC database.
amsterattribute:jdbcUrl - JDBC Driver
-
Fully qualified JDBC driver class name.
amsterattribute:driverClassName - Database Username
-
Specifies the username to access the database server.
amsterattribute:username - Database Password
-
Specifies the password to access the database server.
amsterattribute:password - Connection Timeout (seconds)
-
Specifies the maximum wait time before failing the connection, in seconds.
Default value:
30amsterattribute:connectionTimeout - Maximum Connection Idle Timeout (seconds)
-
Specifies the maximum idle time before the connection is closed, in seconds.
Default value:
600amsterattribute:idleTimeout - Maximum Connection Time (seconds)
-
Specifies the maximum time a JDBC connection can be open, in seconds.
Default value:
1800amsterattribute:maxLifetime - Minimum Idle Connections
-
Specifies the minimum number of idle connections in the connection pool.
Default value:
10amsterattribute:minIdle - Maximum Connections
-
Specifies the maximum number of connections in the connection pool.
Default value:
10amsterattribute:maxPoolSize
Buffering
The Buffering tab contains the following secondary configuration properties:
- Buffering Enabled
-
Enables or disables audit event buffering.
Default value:
trueamsterattribute:bufferingEnabled - Buffer Size (number of events)
-
Size of the queue where events are buffered before they are written to the database.
This queue has to be big enough to store all incoming events that have not yet been written to the database.
If the queue reaches capacity, the process will block until a write occurs.
Default value:
100000amsterattribute:bufferingMaxSize - Write Interval
-
Specifies the interval (seconds) at which buffered events are written to the database.
Default value:
5amsterattribute:bufferingWriteInterval - Writer Threads
-
Specifies the number of threads used to write the buffered events.
Default value:
1amsterattribute:bufferingWriterThreads - Max Batched Events
-
Specifies the maximum number of batched statements the database can support per connection.
Default value:
100amsterattribute:bufferingMaxBatchedEvents
JSON
A configured secondary instance of the JSON type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.JsonAuditEventHandlerFactoryamsterattribute:handlerFactory
JSON configuration
The JSON Configuration tab contains the following secondary configuration properties:
- Log Directory
-
Directory in which to store audit log JSON files.
Default value:
%BASE_DIR%/var/audit/amsterattribute:location - ElasticSearch JSON Format Compatible
-
JSON format should be transformed to be compatible with ElasticSearch format restrictions.
Default value:
falseamsterattribute:elasticsearchCompatible - File Rotation Retention Check Interval
-
Interval to check time-based file rotation policies, in seconds.
Default value:
5amsterattribute:rotationRetentionCheckInterval
File rotation
The File Rotation tab contains the following secondary configuration properties:
- Rotation Enabled
-
Enables and disables audit file rotation.
Default value:
trueamsterattribute:rotationEnabled - Maximum File Size
-
Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.
Default value:
100000000amsterattribute:rotationMaxFileSize - File Rotation Prefix
-
Prefix to prepend to audit files when rotating audit files.
amsterattribute:rotationFilePrefix - File Rotation Suffix
-
Suffix to append to audit files when they are rotated. Suffix should be a timestamp.
Default value:
-yyyy.MM.dd-HH.mm.ssamsterattribute:rotationFileSuffix - Rotation Interval
-
Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.
Default value:
-1amsterattribute:rotationInterval - Rotation Times
-
Durations after midnight to trigger file rotation, in seconds.
amsterattribute:rotationTimes
File retention
The File Retention tab contains the following secondary configuration properties:
- Maximum Number of Historical Files
-
Maximum number of backup audit files allowed. A value of
-1disables pruning of old history files.Default value:
1amsterattribute:retentionMaxNumberOfHistoryFiles - Maximum Disk Space
-
The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.
Default value:
-1amsterattribute:retentionMaxDiskSpaceToUse - Minimum Free Space Required
-
Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.
Default value:
-1amsterattribute:retentionMinFreeSpaceRequired
Buffering
The Buffering tab contains the following secondary configuration properties:
- Batch Size
-
Maximum number of events that can be buffered (default/minimum: 100000)
Default value:
100000amsterattribute:bufferingMaxSize - Write interval
-
Interval at which buffered events are written to a file, in milliseconds.
Default value:
5amsterattribute:bufferingWriteInterval
Splunk
A configured secondary instance of the Splunk type has the following tabs:
General handler configuration
The General Handler Configuration tab contains the following secondary configuration properties:
- Enabled
-
Enables or disables an audit event handler.
Default value:
trueamsterattribute:enabled - Topics
-
List of topics handled by an audit event handler.
Default value:
access activity config authentication
amsterattribute:topics
Audit event handler factory
The Audit Event Handler Factory tab contains the following secondary configuration properties:
- Factory Class Name
-
The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement
org.forgerock.openam.audit.AuditEventHandlerFactory.Default value:
org.forgerock.openam.audit.events.handlers.SplunkAuditEventHandlerFactoryamsterattribute:handlerFactory
Splunk Configuration
The Splunk Configuration tab contains the following secondary configuration properties:
- Authorization Token
-
Authorization token used to connect to Splunk HTTP Event Collector endpoint.
amsterattribute:authzToken - Server Hostname
-
Host name or IP address of Splunk server.
amsterattribute:host - Server Port
-
Port number of Splunk server.
amsterattribute:port - SSL Enabled
-
Use HTTPS protocol for communication with Splunk.
Default value:
falseamsterattribute:sslEnabled
Buffering
The Buffering tab contains the following secondary configuration properties:
- Batch Size
-
Maximum number of events that can be buffered (default: 10000).
Default value:
500amsterattribute:batchSize - Queue Capacity
-
Maximum number of audit evens in the batch queue; additional events are dropped.
Default value:
10000amsterattribute:maxEvents - Write interval (in milliseconds)
-
Interval at which buffered events are written to Splunk.
Default value:
250amsterattribute:writeInterval
Base URL source
amster service name: BaseUrlSource
Realm defaults
The following settings appear on the Realm Defaults tab:
- Base URL Source
-
Specifies how the base URL is generated.
The following values are supported:
-
Extension class (
EXTENSION_CLASS). The extension class returns a base URL from a provided HttpServletRequest. In the Extension class name field, enterorg.forgerock.openam.services.baseurl.BaseURLProvider. -
Fixed value (
FIXED_VALUE). The base URL is retrieved from the value specified in the Fixed value base URL field. -
Forwarded header (
FORWARDED_HEADER). The base URL is retrieved from a forwarded header field in the HTTP request. The Forwarded HTTP header field is standardized and specified in RFC7239. -
Host/protocol from incoming request (
REQUEST_VALUES). The hostname, server name, and port are retrieved from the incoming HTTP request. -
X-Forwarded-* headers (
X_FORWARDED_HEADERS). The base URL is retrieved from non-standard header fields, such asX-Forwarded-For,X-Forwarded-By,X-Forwarded-Proto,X-Forwarded-HostandX-Forwarded-Port.If the
X-Forwarded-Protoheader is not provided, the server uses a fallback scheme, based on the URI of the request.If multiple
X-Forwarded-Hostheaders are specified, the outermost proxy host is used.
Default value:
REQUEST_VALUESamsterattribute:source -
- Fixed value base URL
-
If
Fixed valueis selected as the Base URL source, enter the base URL in the Fixed value base URL field.amsterattribute:fixedValue - Extension class name
-
If
Extension classis selected as the Base URL source, enterorg.forgerock.openam.services.baseurl.BaseURLProviderin the Extension class name field.amsterattribute:extensionClassName - Context path
-
Specifies the context path for the base URL.
If provided, the base URL includes the deployment context path appended to the calculated URL.
For example,
/openam.Default value:
/openamamsterattribute:contextPath
Common federation configuration
amster service name: CommonFederationConfiguration
General configuration
The following settings appear on the General Configuration tab:
- Maximum allowed content length
-
The maximum content length allowed in federation communications, in bytes.
Default value:
20480amsterattribute:maxContentLength - Check presence of certificates
-
Enable checking of certificates against local copy
Whether to verify that the partner’s signing certificate included in the Federation XML document is the same as the one stored in the said partner’s meta data.
The possible values for this property are:
-
off. Disabled -
on. Enabled
Default value:
onamsterattribute:certificateChecking -
- SAML Error Page URL
-
AM redirects users here when an error occurs in the SAML2 engine.
Both relative and absolute URLs are supported. Users are redirected to an absolute URL using the configured HTTP Binding whereas relative URLs are displayed within the request.
Default value:
/saml2/jsp/saml2error.jspamsterattribute:samlErrorPageUrl - SAML Error Page HTTP Binding
-
The possible values are HTTP-Redirect or HTTP-POST.
Default value:
HTTP-POSTamsterattribute:samlErrorPageHttpBinding
Implementation classes
The following settings appear on the Implementation Classes tab:
- Datastore SPI implementation class
-
The Federation system uses this class to get/set user profile attributes.
The default implementation uses the Identity repository APIs to access user profile attributes. A custom implementation must implement the
com.sun.identity.plugin.datastore.DataStoreProviderinterface.Default value:
com.sun.identity.plugin.datastore.impl.IdRepoDataStoreProvideramsterattribute:datastoreClass - Root URL provider SPI implementation class
-
The Federation system uses this class to get the root URL of the AM deployment.
The default implementation uses the Root URL APIs to access the AM instance root url. A custom implementation must implement the
org.forgerock.openam.federation.plugin.rooturl.RootUrlProviderinterface.Default value:
org.forgerock.openam.federation.plugin.rooturl.impl.FmRootUrlProvideramsterattribute:rootUrlProviderClass - ConfigurationInstance SPI implementation class
-
The Federation system uses this class to fetch service configuration.
The default implementation uses the SMS APIs to access service configuration. A custom implementation must implement the
com.sun.identity.plugin.configuration.ConfigurationInstanceinterface.Default value:
com.sun.identity.plugin.configuration.impl.ConfigurationInstanceImplamsterattribute:configurationClass - Logger SPI implementation class
-
The Federation system uses this class to record log entries.
The default implementation uses the Logging APIs to record log entries. A custom implementation must implement the
com.sun.identity.plugin.log.Loggerinterface.Default value:
com.sun.identity.plugin.log.impl.LogProvideramsterattribute:loggerClass - SessionProvider SPI implementation class
-
The Federation system uses this class to interface with the session service.
The default implementation uses the standard authentication and SSO APIs to access the session service. A custom implementation must implement the
com.sun.identity.plugin.session.SessionProviderinterface.Default value:
com.sun.identity.plugin.session.impl.FMSessionProvideramsterattribute:sessionProviderClass - PasswordDecoder SPI implementation class
-
The Federation system uses this class to decode password encoded by AM.
The default implementation uses the internal AM decryption API to decode passwords. A custom implementation must implement the
com.sun.identity.saml.xmlsig.PasswordDecoderinterface.Default value:
com.sun.identity.saml.xmlsig.FMPasswordDecoderamsterattribute:passwordDecoderClass - SignatureProvider SPI implementation class
-
The Federation system uses this class to digitally sign SAML documents.
The default implementation uses the XERCES APIs to sign the documents. A custom implementation must implement the
com.sun.identity.saml.xmlsig.SignatureProviderinterface.Default value:
com.sun.identity.saml.xmlsig.AMSignatureProvideramsterattribute:signatureProviderClass - KeyProvider SPI implementation class
-
The Federation system uses this class to provide access to the underlying Java keystore.
The default implementation uses the Java Cryptographic Engine to provide access to the Java keystore. A custom implementation must implement the
com.sun.identity.saml.xmlsig.KeyProviderinterface.Default value:
com.sun.identity.saml.xmlsig.JKSKeyProvideramsterattribute:keyProviderClass
Algorithms
The following settings appear on the Algorithms tab:
- XML canonicalization algorithm
-
The algorithm used to canonicalize XML documents.
The possible values for this property are:
Default value:
http://www.w3.org/2001/10/xml-exc-c14n#amsterattribute:cannonicalizationAlgorithm - XML signature algorithm
-
The algorithm used to sign XML documents.
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmldsig-more#rsa-sha256amsterattribute:signatureAlgorithm - XML digest algorithm
-
The default digest algorithm to use in signing XML.
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmlenc#sha256amsterattribute:DigestAlgorithm - Query String signature algorithm (RSA)
-
The default signature algorithm to use for RSA keys.
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmldsig-more#rsa-sha256amsterattribute:QuerySignatureAlgorithmRSA - Query String signature algorithm (DSA)
-
The default signature algorithm to use for DSA keys.
This property can only take the following value:
Default value:
http://www.w3.org/2009/xmldsig11#dsa-sha256amsterattribute:QuerySignatureAlgorithmDSA - Query String signature algorithm (EC)
-
The default signature algorithm to use for EC keys.
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512amsterattribute:QuerySignatureAlgorithmEC - XML transformation algorithm
-
The algorithm used to transform XML documents.
The possible values for this property are:
Default value:
http://www.w3.org/2001/10/xml-exc-c14n#amsterattribute:transformationAlgorithm - Mask Generation Function Algorithm
-
Which MGF algorithm to use when encrypting the symmetric encryption key using RSA OAEP algorithm.
The possible values for this property are:
Default value:
http://www.w3.org/2009/xmlenc11#mgf1sha256amsterattribute:maskGenerationFunction - AES Key Wrap Algorithm
-
The AES key wrap algorithm to use when the remote entity provider does not specify which key wrap algorithms it supports.
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmlenc#kw-aes256amsterattribute:aesKeyWrapAlgorithm - RSA Key Transport Algorithm
-
The possible values for this property are:
Default value:
http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1pamsterattribute:rsaKeyTransportAlgorithm
Monitoring
The following settings appear on the Monitoring tab:
- Monitoring Agent Provider Class
-
The Federation system uses this class to gain access to the monitoring system.
The default implementation uses the built-in AM monitoring system. A custom implementation must implement the
com.sun.identity.plugin.monitoring.FedMonAgentinterface.Default value:
com.sun.identity.plugin.monitoring.impl.AgentProvideramsterattribute:monitoringAgentClass - Monitoring Provider Class for SAML2
-
The SAML2 engine uses this class to gain access to the monitoring system.
The default implementation uses the built-in AM monitoring system. A custom implementation must implement the
com.sun.identity.plugin.monitoring.FedMonSAML2Svcinterface.Default value:
com.sun.identity.plugin.monitoring.impl.FedMonSAML2SvcProvideramsterattribute:monitoringSaml2Class
Configuration Version service
amster service name: ConfigurationVersionService
The following settings are available in this service:
- configurationCommit
-
amsterattribute:configurationCommit - Configuration Version
-
AM’s configuration version
Default value:
3.0.0.1amsterattribute:configurationVersion
CORS service
amster service name: CorsConfiguration
Configuration
The following settings appear on the Configuration tab:
- Enable the CORS filter
-
If disable, no CORS headers will be added to responses.
Default value:
trueamsterattribute:enabled
Secondary configurations
This service has the following secondary configurations.
configuration
- Enable the CORS filter
-
If disable, no CORS headers will be added to responses.
Default value:
falseamsterattribute:enabled - Accepted Origins
-
The set of accepted origins.
amsterattribute:acceptedOrigins - Accepted Methods
-
The set of (non-simple) accepted methods, included in the pre-flight response in the header Access-Control-Allow-Methods.
amsterattribute:acceptedMethods - Accepted Headers
-
The set of (non-simple) accepted headers, included in the pre-flight response in the header Access-Control-Allow-Headers.
amsterattribute:acceptedHeaders - Exposed Headers
-
The set of headers to transmit in the header Access-Control-Expose-Headers.
amsterattribute:exposedHeaders - Max Age
-
The max age (in seconds) for caching, included in the pre-flight response in the header Access-Control-Max-Age.
Default value:
0amsterattribute:maxAge - Allow Credentials
-
Whether to transmit the Access-Control-Allow-Credentials: true header in the response.
Default value:
falseamsterattribute:allowCredentials
Dashboard
amster service name: DashboardUserService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Available Dashboard Apps
-
List of application dashboard names available by default for realms with the Dashboard service configured.
amsterattribute:assignedDashboard
Secondary configurations
This service has the following secondary configurations.
instances
- Dashboard Class Name
-
Identifies how to access the application, for example
SAML2ApplicationClassfor a SAML v2.0 application.amsterattribute:className - Dashboard Name
-
The application name as it will appear to the administrator for configuring the dashboard.
amsterattribute:name - Dashboard Display Name
-
The application name that displays on the dashboard client.
amsterattribute:displayName - Dashboard Icon
-
The icon name that will be displayed on the dashboard client identifying the application.
amsterattribute:icon - Dashboard Login
-
The URL that takes the user to the application.
amsterattribute:login - ICF Identifier
-
amsterattribute:icfIdentifier
Device ID service
amster service name: deviceIdService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Profile Storage Attribute
-
The user’s attribute in which to store Device ID profiles.
The default attribute is added to the schema when you prepare a user store for use with AM. If you want to use a different attribute, you must make sure to add it to your user store schema prior to enabling the Device ID authentication module. AM must be able to write to the attribute.
Default value:
devicePrintProfilesamsterattribute:deviceIdAttrName - Device Profile Encryption Scheme
-
Encryption scheme to use to secure device profiles stored on the server.
If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.
AES-256 may require installation of the JCE Unlimited Strength policy files. The possible values for this property are:
-
Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (value:
RSAES_AES256CBC_HS512) -
Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (value:
RSAES_AES128CBC_HS256) -
Label: No encryption of device settings (value:
NONE)
Default value:
NONEamsterattribute:deviceIdSettingsEncryptionScheme -
- Encryption Key Store
-
Path to the key store from which to load encryption keys.
Default value:
/path/to/openam/security/keystores/keystore.jksamsterattribute:deviceIdSettingsEncryptionKeystore - Key Store Type
-
Type of key store to load.
PKCS#11 key stores require hardware support such as a security device or smart card and is not available by default in most JVM installations. See the JDK 8 PKCS#11 Reference Guide for more details.
The possible values for this property are:
-
Label: Java Key Store (JKS) (value:
JKS) -
Label: Java Cryptography Extension Key Store (JCEKS) (value:
JCEKS) -
Label: PKCS#11 Hardware Crypto Storage (value:
PKCS11) -
Label: PKCS#12 Key Store (value:
PKCS12)
Default value:
JKSamsterattribute:deviceIdSettingsEncryptionKeystoreType -
- Key Store Password
-
Password to unlock the key store. This password is encrypted when it is saved in the AM configuration. You should modify the default value.
amsterattribute:deviceIdSettingsEncryptionKeystorePassword - Key-Pair Alias
-
Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.
amsterattribute:deviceIdSettingsEncryptionKeystoreKeyPairAlias - Private Key Password
-
Password to unlock the private key.
amsterattribute:deviceIdSettingsEncryptionKeystorePrivateKeyPassword
Device Profiles service
amster service name: DeviceProfilesService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Profile Storage Attribute
-
The user’s attribute in which to store Device profiles.
The default attribute is added to the schema when you prepare a user store for use with AM. If you want to use a different attribute, you must make sure to add it to your user store schema prior to enabling the Device Profiles authentication module. AM must be able to write to the attribute.
Default value:
deviceProfilesamsterattribute:deviceProfilesAttrName - Device Profile Encryption Scheme
-
Encryption scheme to use to secure device profiles stored on the server.
If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.
AES-256 may require installation of the JCE Unlimited Strength policy files. The possible values for this property are:
-
Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (value:
RSAES_AES256CBC_HS512) -
Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (value:
RSAES_AES128CBC_HS256) -
Label: No encryption of device settings (value:
NONE)
Default value:
NONEamsterattribute:deviceProfilesSettingsEncryptionScheme -
- Encryption Key Store
-
Path to the key store from which to load encryption keys.
Default value:
/path/to/openam/security/keystores/keystore.jksamsterattribute:deviceProfilesSettingsEncryptionKeystore - Key Store Type
-
Type of key store to load.
PKCS#11 key stores require hardware support such as a security device or smart card and is not available by default in most JVM installations. See the JDK 8 PKCS#11 Reference Guide for more details.
The possible values for this property are:
-
Label: Java Key Store (JKS) (value:
JKS) -
Label: Java Cryptography Extension Key Store (JCEKS) (value:
JCEKS) -
Label: PKCS#11 Hardware Crypto Storage (value:
PKCS11) -
Label: PKCS#12 Key Store (value:
PKCS12)
Default value:
JKSamsterattribute:deviceProfilesSettingsEncryptionKeystoreType -
- Key Store Password
-
Password to unlock the key store. This password is encrypted when it is saved in the AM configuration. You should modify the default value.
amsterattribute:deviceProfilesSettingsEncryptionKeystorePassword - Key-Pair Alias
-
Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.
amsterattribute:deviceProfilesSettingsEncryptionKeystoreKeyPairAlias - Private Key Password
-
Password to unlock the private key.
amsterattribute:deviceProfilesSettingsEncryptionKeystorePrivateKeyPassword
Email service
amster service name: EmailService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Email From Address
-
Specifies the address from which to send email notifications.
For example, you might set this property to: no-reply@example.com
For Microsoft Graph API transport configurations, this must exist as a valid address in the Microsoft Exchange administration center.
amsterattribute:from - Email Attribute Name
-
Specifies the profile attribute from which to retrieve the end user’s email address.
Default value:
mailamsterattribute:emailAddressAttribute - Email Subject
-
Specifies a subject for notification messages. If you do not set this, AM does not set the subject for notification messages.
amsterattribute:subject - Email Content
-
Specifies content for notification messages. If you do not set this, AM includes only the confirmation URL in the mail body.
amsterattribute:message - Email Rate Limit
-
Specifies the minimum number of seconds that must elapse between sending emails to an individual user.
Default value:
1amsterattribute:emailRateLimitSeconds - Transport Type
-
The mail server transport type to use. This value must be set to one of the secondary configurations.
amsterattribute:transportType
Secondary configurations
This service has the following secondary configurations.
Microsoft Graph API
- Email Message Implementation Class
-
Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.
Default value:
org.forgerock.openam.services.email.rest.MicrosoftRestMailServeramsterattribute:emailImplClassName - Email Rest Endpoint URL
-
Specifies the REST endpoint for sending emails, in the format
https://graph.microsoft.com/v1.0/users/USER ID/sendMail.Refer to the sendMail API reference for details.
amsterattribute:emailEndpoint - OAuth2 Token Endpoint URL
-
Specifies the endpoint for OAuth 2.0 authentication, in the format
https://login.microsoftonline.com/TENANT ID/oauth2/v2.0/token.amsterattribute:tokenEndpoint - OAuth2 Client Id
-
Specifies the client ID for use in OAuth 2.0 authentication.
This is the client ID or application ID provided by the Microsoft Application Registration portal.
amsterattribute:clientId - OAuth2 Scopes
-
Specifies the scopes to request as part of the OAuth 2.0 authentication.
The value supported by Microsoft Graph API is
https://graph.microsoft.com/.default.amsterattribute:scope
SMTP
- Email Message Implementation Class
-
Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.
Default value:
org.forgerock.openam.services.email.MailServerImplamsterattribute:emailImplClassName - Mail Server Host Name
-
Specifies the fully qualified domain name of the SMTP mail server through which to send email notifications.
For example, you might set this property to: smtp.example.com
amsterattribute:hostname - Mail Server Host Port
-
Specifies the port number for the SMTP mail server.
Default value:
465amsterattribute:port - Mail Server Authentication Username
-
Specifies the username for the SMTP mail server.
For example, you might set this property to: username
amsterattribute:username - Mail Server Authentication Password
-
Specifies the password for the SMTP user name.
amsterattribute:password - Mail Server Secure Connection
-
Specifies whether to connect to the SMTP mail server using SSL.
The possible values for this property are:
-
SSL -
Non SSL -
Start TLS
Default value:
SSLamsterattribute:sslState -
External data stores
amster service name: DataStoreService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Policy Data Store
-
Select a data store configuration to be used for policy storage
The possible values for this property are:
-
Label: Default Data Store (value:
fd270e31-1788-4193-8734-eb2d500c47f3)
Default value:
fd270e31-1788-4193-8734-eb2d500c47f3amsterattribute:policyDataStoreId -
- Application Data Store
-
Select a data store configuration to be used for application storage
The possible values for this property are:
-
Label: Default Data Store (value:
fd270e31-1788-4193-8734-eb2d500c47f3)
Default value:
fd270e31-1788-4193-8734-eb2d500c47f3amsterattribute:applicationDataStoreId -
Secondary configurations
This service has the following secondary configurations.
config
- Host Urls
-
An ordered list of connection strings for LDAP directories.Each connection string is composed as follows: HOST:PORT. serverHostname = Host Name
amsterattribute:serverUrls - Bind DN
-
amsterattribute:bindDN - Bind Password
-
amsterattribute:bindPassword - Minimum Connection Pool Size
-
Default value:
1amsterattribute:minimumConnectionPool - Maximum Connection Pool Size
-
Default value:
10amsterattribute:maximumConnectionPool - Use SSL
-
amsterattribute:useSsl - Start TLS
-
amsterattribute:useStartTLS - Affinity Enabled
-
amsterattribute:affinityEnabled
ForgeRock Authenticator (OATH) service
amster service name: AuthenticatorOath
Realm defaults
The following settings appear on the Realm Defaults tab:
- Profile Storage Attribute
-
Attribute for storing ForgeRock Authenticator OATH profiles.
The default attribute is added to the user store during AM installation. If you want to use a different attribute, you must make sure to add it to your user store schema prior to deploying two-step verification with a ForgeRock OATH authenticator app in AM. AM must be able to write to the attribute.
Default value:
oathDeviceProfilesamsterattribute:oathAttrName - Device Profile Encryption Scheme
-
Encryption scheme for securing device profiles stored on the server.
If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.
AES-256 may require installation of the JCE Unlimited Strength policy files. The possible values for this property are:
-
Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value:
RSAES_AES256CBC_HS512) -
Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value:
RSAES_AES128CBC_HS256) -
Label: No encryption of device settings. (Value:
NONE)
Default value:
NONEamsterattribute:authenticatorOATHDeviceSettingsEncryptionScheme -
- Encryption Key Store
-
Path to the key store from which to load encryption keys.
Default value:
/path/to/openam/openam/keystore.jksamsterattribute:authenticatorOATHDeviceSettingsEncryptionKeystore - Key Store Type
-
Type of encryption key store.
PKCS#11 keys tores require hardware support such as a security device or smart card and is not available by default in most JVM installations. See the JDK 8 PKCS#11 Reference Guide for more details.
The possible values for this property are:
-
Label: Java Key Store (JKS). (Value:
JKS) -
Label: Java Cryptography Extension Key Store (JCEKS). (Value:
JCEKS) -
Label: PKCS#11 Hardware Crypto Storage. (Value:
PKCS11) -
Label: PKCS#12 Key Store. (Value:
PKCS12)
Default value:
JKSamsterattribute:authenticatorOATHDeviceSettingsEncryptionKeystoreType -
- Key Store Password
-
Password to unlock the key store. This password will be encrypted.
amsterattribute:authenticatorOATHDeviceSettingsEncryptionKeystorePassword - Key-Pair Alias
-
Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.
Default value:
pushDeviceProfilesamsterattribute:authenticatorOATHDeviceSettingsEncryptionKeystoreKeyPairAlias - Private Key Password
-
Password to unlock the private key.
amsterattribute:authenticatorOATHDeviceSettingsEncryptionKeystorePrivateKeyPassword - ForgeRock Authenticator (OATH) Device Skippable Attribute Name
-
The data store attribute that holds the user’s decision to enable or disable obtaining and providing a password obtained from the ForgeRock Authenticator app. This attribute must be writable.
Default value:
oath2faEnabledamsterattribute:authenticatorOATHSkippableName
ForgeRock Authenticator (Push) service
amster service name: AuthenticatorPush
Realm defaults
The following settings appear on the Realm Defaults tab:
- Profile Storage Attribute
-
The user’s attribute in which to store Push Notification profiles.
The default attribute is added to the schema when you prepare a user store for use with AM. If you want to use a different attribute, you must make sure to add it to your user store schema prior to deploying push notifications with the ForgeRock Authenticator app in AM. AM must be able to write to the attribute.
Default value:
pushDeviceProfilesamsterattribute:pushAttrName - Device Profile Encryption Scheme
-
Encryption scheme to use to secure device profiles stored on the server.
If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.
AES-256 may require installation of the JCE Unlimited Strength policy files. The possible values for this property are:
-
Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (value:
RSAES_AES256CBC_HS512) -
Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (value:
RSAES_AES128CBC_HS256) -
Label: No encryption of device settings (value:
NONE)
Default value:
NONEamsterattribute:authenticatorPushDeviceSettingsEncryptionScheme -
- Encryption Key Store
-
Path to the key store from which to load encryption keys.
Default value:
/path/to/openam/openam/keystore.jksamsterattribute:authenticatorPushDeviceSettingsEncryptionKeystore - Key Store Type
-
Type of key store to load.
PKCS#11 key stores require hardware support such as a security device or smart card and is not available by default in most JVM installations. See the JDK 8 PKCS#11 Reference Guide for more details.
The possible values for this property are:
-
Label: Java Key Store (JKS) (value:
JKS) -
Label: Java Cryptography Extension Key Store (JCEKS) (value:
JCEKS) -
Label: PKCS#11 Hardware Crypto Storage (value:
PKCS11) -
Label: PKCS#12 Key Store (value:
PKCS12)
Default value:
JKSamsterattribute:authenticatorPushDeviceSettingsEncryptionKeystoreType -
- Key Store Password
-
Password to unlock the key store. This password is encrypted when it is saved in the AM configuration. You should modify the default value.
amsterattribute:authenticatorPushDeviceSettingsEncryptionKeystorePassword - Key-Pair Alias
-
Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.
amsterattribute:authenticatorPushDeviceSettingsEncryptionKeystoreKeyPairAlias - Private Key Password
-
Password to unlock the private key.
amsterattribute:authenticatorPushDeviceSettingsEncryptionKeystorePrivateKeyPassword - ForgeRock Authenticator (Push) Device Skippable Attribute Name
-
Name of the attribute on a user’s profile used to store their selection of whether to skip ForgeRock Authenticator (Push) 2FA modules.
Default value:
push2faEnabledamsterattribute:authenticatorPushSkippableName
Globalization settings
amster service name: Globalization
Global attributes
The following settings appear on the Global Attributes tab:
- Charsets Supported by Each Locale
-
This table lets you configure the order of supported character sets used for each supported locale. Change the settings only if the defaults are not appropriate.
Default value:
locale=zh|charset=UTF-8;GB2312 locale=ar|charset=UTF-8;ISO-8859-6 locale=es|charset=UTF-8;ISO-8859-15 locale=de|charset=UTF-8;ISO-8859-15 locale=zh_TW|charset=UTF-8;BIG5 locale=fr|charset=UTF-8;ISO-8859-15 locale=ko|charset=UTF-8;EUC-KR locale=en|charset=UTF-8;ISO-8859-1 locale=th|charset=UTF-8;TIS-620 locale=ja|charset=UTF-8;Shift_JIS;EUC-JP
amsterattribute:charsetMappings - Charset Aliases
-
Use this list to map between different character set names used in Java and in MIME.
Default value:
mimeName=EUC-KR|javaName=EUC_KR mimeName=EUC-JP|javaName=EUC_JP mimeName=Shift_JIS|javaName=SJIS
amsterattribute:sun-identity-g11n-settings-charset-alias-mapping
Realm defaults
The following settings appear on the Realm Defaults tab:
- Auto Generated Common Name Format
-
Use this list to configure how AM formats names shown in the console banner.
This setting allows the name of the authenticated user shown in the AM admin UI banner to be customised based on the locale of the user.
Default value:
zh={sn}{givenname}amsterattribute:commonNameFormats
Google Cloud platform service accounts
amster service name: GoogleCloudServiceAccountService
Secondary configurations
This service has the following secondary configurations.
serviceAccounts
- Credentials Secret ID
-
The ID of the secret that contains the GCP service account credentials. Leave blank to usethe default credentials from the environment. Credentials can be loaded from disk using a FileSystem Secret Store.
amsterattribute:credentialsSecretId - Allowed Realms
-
A list of realms that are allowed to use this service account. Realms should be specified in path form, such as
/subrealm/subsubrealm.amsterattribute:allowedRealms - Allowed Secret Names
-
A list of patterns of Google Secret Manager secret names that are allowed to be usedwith this service account. Patterns can include the wildcard "*".
Default value:
*amsterattribute:allowedSecretNamePatterns - Disallowed Secret Names
-
A list of patterns of Google Secret Manager secret names that are not allowed to be used with this service account. Patterns can include the wildcard "*".
amsterattribute:disallowedSecretNamePatterns
IDM Provisioning
amster service name: IDMProvisioning
The following settings are available in this service:
- Enabled
-
Default value:
falseamsterattribute:enabled - Deployment URL
-
URL of the IDM deployment, for example,
https://localhost:8080.amsterattribute:idmDeploymentUrl - Deployment Path
-
Path of the IDM deployment, for example,
openidm.amsterattribute:idmDeploymentPath - IDM Provisioning Client
-
The name of the oauth client to be used for the client credentials flow.
amsterattribute:idmProvisioningClient - Signing Key Alias
-
Alias of the signing symmetric key in AM’s default keystore. Must be a duplicate of the symmetric key used by IDM.
amsterattribute:provisioningSigningKeyAlias - Encryption Key Alias
-
Alias of the encryption asymmetric key in AM’s default keystore. Must be a duplicate of the asymmetric key used by IDM.
amsterattribute:provisioningEncryptionKeyAlias - Signing Algorithm
-
JWT signing algorithm.
amsterattribute:provisioningSigningAlgorithm - Signing Compatibility Mode
-
Enable AM to communicate with IDM 6 and earlier.
When this option is enabled, AM will sign JWTs in a way that is compatible with versions of IDM 6 and earlier. The approach used is incompatible with non-extractable HSM keys. Disable this option if you have upgraded to IDM 6.5 or later.
Default value:
falseamsterattribute:jwtSigningCompatibilityMode - Encryption Algorithm
-
JWT encryption algorithm.
amsterattribute:provisioningEncryptionAlgorithm - Encryption Method
-
JWT encryption method.
amsterattribute:provisioningEncryptionMethod
- Configuration Cache Duration
-
Specify a duration in minutes for caching static IDM configuration to reduce calls to IDM endpoints and improve performance.
The following values are cached for the specified duration: IDM schemas, consent mappings, validation requirements, KBA configuration, and the IDM active terms.
If changes are made to the IDM Provisioning service in AM during this period, the configuration cache is immediately cleared. If, however, changes are made to IDM, the cache is only refreshed when the duration expires.
A zero value disables this feature.
Default value:
0amsterattribute:configurationCacheDuration
IoT service
amster service name: IoTService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Create OAuth 2.0 Client
-
Create an OAuth 2.0 Client with the given name and default configuration required to serve as the client for the IoT Service. The client will be created without any scope(s).
Default value:
falseamsterattribute:createOAuthClient - OAuth 2.0 Client Name
-
The name of the default OAuth 2.0 Client used by the IoT Service to request access tokens for things.
Default value:
forgerock-iot-oauth2-clientamsterattribute:oauthClientName - Create OAuth 2.0 JWT Issuer
-
Create a Trusted JWT Issuer with the given name and default configuration required for the IoT Service to act as the Issuer when handling request for thing access tokens.
Default value:
falseamsterattribute:createOAuthJwtIssuer - OAuth 2.0 JWT Issuer Name
-
The name of the Trusted JWT Issuer used by the IoT Service to request access tokens for things.
Default value:
forgerock-iot-jwt-issueramsterattribute:oauthJwtIssuerName - OAuth 2.0 Subject Attribute
-
The name of the identity store attribute from which to read the OAuth 2.0 subject value. The subject is used in access tokens issued for things. This allows the thing’s access token subject to have a value other than the thing’s ID, which is the value used by default.
amsterattribute:oauthSubjectAttribute - Readable Attributes
-
Specifies the list of attributes that a thing is allowed to request from its identity.
Default value:
thingConfigamsterattribute:attributeAllowlist
Legacy User Self-Service
amster service name: SecurityProperties
Realm defaults
The following settings appear on the Realm Defaults tab:
- Legacy Self-Service REST Endpoint
-
Specify whether to enable the legacy self-service endpoint.
AM supports two user self-service components: the Legacy User Self-Service, which is based on a Java SDK and is available in AM versions prior to AM 13, and a common REST-based/XUI-based User Self-Service available in AM 13 and later.
The Legacy User Self-Service will be deprecated in a future release.
Default value:
falseamsterattribute:selfServiceEnabled - Self-Registration for Users
-
If enabled, new users can sign up using a REST API client.
Default value:
falseamsterattribute:selfRegistrationEnabled - Self-Registration Token LifeTime (seconds)
-
Maximum life time for the token allowing User Self-Registration using the REST API.
Default value:
900amsterattribute:selfRegistrationTokenLifetime - Self-Registration Confirmation Email URL
-
This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.
Default value:
http://openam.example.com:8080/openam/XUI/confirm.htmlamsterattribute:selfRegistrationConfirmationUrl - Forgot Password for Users
-
If enabled, users can assign themselves a new password using a REST API client.
Default value:
falseamsterattribute:forgotPasswordEnabled - Forgot Password Token Lifetime (seconds)
-
Maximum life time for the token that allows a user to process a forgotten password using the REST API.
Default value:
900amsterattribute:forgotPasswordTokenLifetime - Forgot Password Confirmation Email URL
-
This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.
Default value:
http://openam.example.com:8080/openam/XUI/confirm.htmlamsterattribute:forgotPasswordConfirmationUrl - Destination After Successful Self-Registration
-
Specifies the behavior when self-registration has successfully completed.
The possible values for this property are:
-
Label: User is sent to a 'successful registration' page, without being logged in (value:
default) -
Label: User is sent to the login page, to authenticate (value:
login) -
Label: User is automatically logged in and sent to the appropriate page within the system (value:
autologin)
Default value:
defaultamsterattribute:userRegisteredDestination -
- Protected User Attributes
-
A list of user profile attributes. Users modifying any of the attributes in this list will be required to enter a password as confirmation before the change is accepted. This option applies to XUI deployments only.
amsterattribute:protectedUserAttributes - Confirmation Id HMAC Signing Key
-
256-bit key (base64-encoded) to use for HMAC signing of the legacy self-service confirmation email links.
Default value:
Bn+TrDWLSv1E3ADHWxgqpv4fZnVmKLqwQcZvGdo/3jU=amsterattribute:confirmationIdHmacKey
Logging
amster service name: Logging
General
The following settings appear on the General tab:
- Log Status
-
Enable the AM logging system.
AM supports two audit logging services: a legacy logging service, based on a Java SDK and available in AM versions prior to AM 13.5, and a new common REST-based audit logging service available, from AM 13.5.
The legacy logging service will be deprecated in a future release.
The possible values for this property are:
-
ACTIVE -
INACTIVE
Default value:
INACTIVEamsterattribute:status -
- Logging Type
-
Specifies whether to log to a database, Syslog, or to the file system.
If you choose database then be sure to set the connection attributes correctly, including the JDBC driver to use.
The possible values for this property are:
-
File -
DB -
Syslog
Default value:
Fileamsterattribute:type -
- Configurable Log Fields
-
Controls the fields that are logged by AM.
This property is the list of fields that are logged by default. Administrators can choose to limit the information logged by AM.
Default value:
IPAddr LoggedBy LoginID NameID ModuleName ContextID Domain LogLevel HostName MessageID
amsterattribute:fields - Log Verification Frequency
-
The frequency (in seconds) that AM verifies security of the log files.
When secure logging is enabled, this is the period that AM will check the integrity of the log files.
Default value:
3600amsterattribute:verifyPeriod - Log Signature Time
-
The frequency (in seconds) that AM will digitally sign the log records.
When secure logging is enabled, this is the period that AM will digitally signed the contents of the log files. The log signatures form the basis of the log file integrity checking.
Default value:
900amsterattribute:signaturePeriod - Secure Logging
-
Enable or disable secure logging.
If this setting is enabled, AM digitally signs and verifies the contents of log files, to help prevent and detect log file tampering. You must configure a certificate for this functionality to be enabled.
The possible values for this property are:
-
ON -
OFF
Default value:
OFFamsterattribute:security -
- Secure Logging Signing Algorithm
-
Determines the algorithm used to digitally sign the log records.
The possible values for this property are:
-
MD2withRSA. MD2 with RSA -
MD5withRSA. MD5 with RSA -
SHA1withDSA. SHA1 with DSA -
SHA1withRSA. SHA1 with RSA
Default value:
SHA1withRSAamsterattribute:signingAlgorithm -
- Logging Certificate Store Location
-
The path to the Java keystore containing the logging system certificate.
The secure logging system will use the certificate alias of
Loggerto locate the certificate in the specified keystore.Default value:
%BASE_DIR%/var/audit/Logger.jksamsterattribute:certificateStore - Number of Files per Archive
-
Controls the number of logs files that will be archived by the secure logging system.
Default value:
5amsterattribute:filesPerKeystore - Buffer Size
-
The number of log records held in memory before the log records will be flushed to the logfile or the database.
Default value:
25amsterattribute:bufferSize - Buffer Time
-
The maximum time (in seconds) AM will hold log records in memory before flushing to the underlying repository.
Default value:
60amsterattribute:bufferTime - Time Buffering
-
Enable or disable log buffering
When enabled AM holds all log records in a memory buffer that it periodically flushes to the repository. The period is set in the
Buffer Timeproperty.The possible values for this property are:
-
ON -
OFF
Default value:
ONamsterattribute:buffering -
- Logging Level
-
Control the level of JDK logging within AM.
The possible values for this property are:
-
OFF -
SEVERE -
WARNING -
INFO -
CONFIG -
FINE -
FINER -
FINEST
Default value:
INFOamsterattribute:jdkLoggingLevel -
File
The following settings appear on the File tab:
- Log Rotation
-
Enable log rotation to cause new log files to be created when configured thresholds are reached, such as Maximum Log Size or Logfile Rotation Interval.
Default value:
trueamsterattribute:rotationEnabled - Maximum Log Size
-
Maximum size of a log file, in bytes.
Default value:
100000000amsterattribute:maxFileSize - Number of History Files
-
Sets the number of history files for each log that AM keeps, including time-based histories.
The previously live file is moved and is included in the history count, and a new log is created to serve as the live log file. Any log file in the history count that goes over the number specified here will be deleted.
For time-based logs, a new set of logs will be created when AM is started because of the time-based file names that are used.
Default value:
1amsterattribute:numberHistoryFiles - Logfile Rotation Prefix
-
The name of the log files will be prefixed with the supplied value.
This field defines the log file prefix. The prefix will be added to the name of all logfiles.
Only used when time-based log rotation is enabled. amsterattribute:prefix - Logfile Rotation Suffix
-
The name of the log files will be suffixed with the supplied value.
This field defines the log file suffix. If no suffix is provided, then the following default suffix format will be used:
-MM.dd.yy-kk.mm. The suffix allows use of Date and Time patterns defined in SimpleDateFormatThis field is only used if the time based rotation is enabled. Default value:
-MM.dd.yy-kk.mmamsterattribute:suffix - Logfile Rotation Interval
-
The rotation interval (in minutes).
The rotation interval determines the frequency of when the log files will be rotated. If the value is
-1, then time based rotation is disabled and log file size based rotation is enabled.Default value:
-1amsterattribute:rotationInterval - Log File Location
-
The path to the location of the log files
This property controls the location of the log files. The value depends on whether File or DB logging is used:
-
File: The full pathname to the directory containing the log files.
-
DB: The JDBC URL to the database used to store the log file database.
Default value:
%BASE_DIR%/var/audit/amsterattribute:location -
Database
The following settings appear on the Database tab:
- Database User Name
-
When logging to a database, set this to the username used to connect to the database. If this attribute is incorrectly set, AM performance suffers.
Default value:
dbuseramsterattribute:user - Database User Password
-
When logging to a database, set this to the password used to connect to the database. If this attribute is incorrectly set, AM performance suffers.
amsterattribute:password - Database Driver Name
-
When logging to a database, set this to the class name of the JDBC driver used to connect to the database.
The default is for Oracle. AM also works with the MySQL database driver.
Default value:
oracle.jdbc.driver.OracleDriveramsterattribute:driver - Maximum Number of Records
-
The maximum number of records read from the logs through the logging API.
Default value:
500amsterattribute:maxRecords - DB Failure Memory Buffer Size
-
Max number of log records held in memory if DB logging fails.
This is the maximum number of log records that will be held in memory if the database is unavailable. When the buffer is full, new log records cause the oldest record in the buffer to be cleared. AM monitoring records the number of log entries cleared when the database was unavailable.
If the value of this property is less than that of the Buffer Size then the buffer size value will take precedence.
Default value:
2amsterattribute:databaseFailureMemoryBufferSize
Syslog
The following settings appear on the Syslog tab:
- Syslog server host
-
The URL or IP address of the syslog server, for example
http://mysyslog.example.com, orlocalhost.Default value:
localhostamsterattribute:host - Syslog server port
-
The port number the syslog server is configured to listen to.
Default value:
514amsterattribute:port - Syslog transport protocol
-
The protocol to use to connect to the syslog server.
The possible values for this property are:
-
UDP -
TCP
Default value:
UDPamsterattribute:protocol -
- Syslog facility
-
Syslog uses the facility level to determine the type of program that is logging the message.
The possible values for this property are:
-
kern -
user -
mail -
daemon -
auth -
syslog -
lpr -
news -
uucp -
cron -
authpriv -
ftp -
local0 -
local1 -
local2 -
local3 -
local4 -
local5 -
local6 -
local7
Default value:
local5amsterattribute:facility -
- Syslog connection timeout
-
The period of time, in seconds, to wait when attempting to connect to the syslog server, before reporting a failure.
Default value:
30amsterattribute:timeout
Monitoring
amster service name: Monitoring
Configuration
The following settings appear on the Configuration tab:
- Monitoring Status
-
Enable / Disable the monitoring system
Default value:
falseamsterattribute:enabled - Monitoring HTTP Port
-
Port number for the HTTP monitoring interface
Default value:
8082amsterattribute:httpPort - Monitoring HTTP interface status
-
Enable / Disable the HTTP access to the monitoring system
Default value:
falseamsterattribute:httpEnabled - Monitoring HTTP interface authentication file path
-
Path to the monitoring system authentication file
The
openam_mon_authfile contains the username and password of the account used to protect the monitoring interfaces. The default username isdemowith a password ofchangeit. Use theampasswordcommand to encrypt a new password.Default value:
%BASE_DIR%/security/openam_mon_authamsterattribute:authfilePath - Monitoring RMI Port
-
Port number for the JMX monitoring interface
Default value:
9999amsterattribute:rmiPort - Monitoring RMI interface status
-
Enable / Disable the JMX access to the monitoring system
Default value:
falseamsterattribute:rmiEnabled - Monitoring SNMP Port
-
Port number for the SNMP monitoring interface
Default value:
8085amsterattribute:snmpPort - Monitoring SNMP interface status
-
Enable / Disable the SNMP access to the monitoring system
Default value:
falseamsterattribute:snmpEnabled - Policy evaluation monitoring history size
-
Size of the window of most recent policy evaluations to record to expose via monitoring system. Valid range is 100 - 1000000.
Default value:
10000amsterattribute:policyHistoryWindowSize - Session monitoring history size
-
Size of the window of most recent session operations to record to expose via monitoring system. Valid range is 100 - 1000000.
Default value:
10000amsterattribute:sessionHistoryWindowSize
Secondary configurations
This service has the following secondary configurations.
graphite
- Hostname
-
The hostname of the Graphite server to which metrics should be published.
amsterattribute:host - Port
-
The port of the Graphite server to which metrics should be published.
Default value:
2004amsterattribute:port - Frequency
-
The frequency (in seconds) at which metrics should be published.
Default value:
30amsterattribute:frequency
Multi-federation protocol
amster service name: MultiFederationProtocol
The following settings are available in this service:
- Single Logout Handler List
-
List of logout handlers for each supported federation protocol
The multi-federation protocol engine supports single logout. Each federation protocol requires a different single logout handler. The logout handler must implement the
com.sun.identity.multiprotocol.SingleLogoutHandlerinterface.Default value:
key=WSFED|class=com.sun.identity.multiprotocol.WSFederationSingleLogoutHandler key=SAML2|class=com.sun.identity.multiprotocol.SAML2SingleLogoutHandler
amsterattribute:singleLogoutHandlerList
Naming
amster service name: Naming
General configuration
The following settings appear on the General Configuration tab:
- Profile Service URL
-
Specifies the endpoint used by the profile service.
This attribute is deprecated.
Default value:
%protocol://%host:%port%uri/profileserviceamsterattribute:profileUrl - Session Service URL
-
Specifies the endpoint used by the session service.
Default value:
%protocol://%host:%port%uri/sessionserviceamsterattribute:sessionUrl - Logging Service URL
-
Specifies the endpoint used by the logging service.
Default value:
%protocol://%host:%port%uri/loggingserviceamsterattribute:loggingUrl - Policy Service URL
-
Specifies the endpoint used by the policy service.
Default value:
%protocol://%host:%port%uri/policyserviceamsterattribute:policyUrl - Authentication Service URL
-
Specifies the endpoint used by the authentication service.
Default value:
%protocol://%host:%port%uri/authserviceamsterattribute:authUrl
Federation configuration
The following settings appear on the Federation Configuration tab:
- SAML Web Profile/Artifact Service URL
-
Specifies the SAML v1 endpoint.
Default value:
%protocol://%host:%port%uri/SAMLAwareServletamsterattribute:samlAwareServletUrl - SAML SOAP Service URL
-
Specifies the SAML v1 SOAP service endpoint.
Default value:
%protocol://%host:%port%uri/SAMLSOAPReceiveramsterattribute:samlSoapReceiverUrl - SAML Web Profile/POST Service URL
-
Specifies the SAML v1 Web Profile endpoint.
Default value:
%protocol://%host:%port%uri/SAMLPOSTProfileServletamsterattribute:samlPostServletUrl - SAML Assertion Manager Service URL
-
Specifies the SAML v1 assertion service endpoint.
Default value:
%protocol://%host:%port%uri/AssertionManagerServlet/AssertionManagerIFamsterattribute:samlAssertionManagerUrl - JAXRPC Endpoint URL
-
(Deprecated) Specifies the JAXRPC endpoint URL used by the remote IDM/SMS APIs.
Default value:
%protocol://%host:%port%uri/jaxrpc/amsterattribute:jaxrpcUrl
Endpoint configuration
The following settings appear on the Endpoint Configuration tab:
- Identity Web Services Endpoint URL
-
Specifies the endpoint for the Identity WSDL services.
Default value:
%protocol://%host:%port%uri/identityservices/amsterattribute:jaxwsUrl - Identity REST Services Endpoint URL
-
Specifies the endpoint for the Identity REST services.
Default value:
%protocol://%host:%port%uri/identity/amsterattribute:idsvcsRestUrl - Security Token Service Endpoint URL
-
Specifies the STS endpoint.
Default value:
%protocol://%host:%port%uri/stsamsterattribute:stsUrl - Security Token Service MEX Endpoint URL
-
Specifies the STS MEX endpoint.
Default value:
%protocol://%host:%port%uri/sts/mexamsterattribute:stsMexUrl
OAuth2 provider
amster service name: OAuth2Provider
Global attributes
The following settings appear on the Global Attributes tab:
- Token Denylist Cache Size
-
Number of denylisted tokens to cache in memory to speed up denylist checks and reduce load on the CTS.
Default value:
10000amsterattribute:blacklistCacheSize - Denylist Poll Interval (seconds)
-
How frequently to poll for token denylist changes from other servers, in seconds.
How often each server will poll the CTS for token denylist changes from other servers. This is used to maintain a highly compressed view of the overall current token denylist improving performance. A lower number will reduce the delay for denylisted tokens to propagate to all servers at the cost of increased CTS load. Set to 0 to disable this feature completely.
Default value:
60amsterattribute:blacklistPollInterval - Denylist Purge Delay (minutes)
-
Length of time to denylist tokens beyond their expiry time.
Allows additional time to account for clock skew to ensure that a token has expired before it is removed from the denylist.
Default value:
1amsterattribute:blacklistPurgeDelay - Client-Side Grant Token Upgrade Compatibility Mode
-
Enable AM to consume and create client-side OAuth 2.0 tokens in two different formats simultaneously.
Enable this option when upgrading AM to allow the new instance to create and consume client-side OAuth 2.0 tokens in both the previous format, and the new format. Disable this option once all AM instances in the cluster have been upgraded.
Default value:
falseamsterattribute:statelessGrantTokenUpgradeCompatibilityMode - CTS Storage Scheme
-
Storage scheme to be used when storing OAuth2 tokens to CTS.
In order to support rolling upgrades, this should be set to the latest storage scheme supported by all AM instances within your cluster. Select the latest storage scheme once all AM instances in the cluster have been upgraded.
One-to-One Storage Scheme
Under this storage scheme, each OAuth2 token maps to an individual CTS entry.
This storage scheme is inefficient - use the Grant-Set Storage Scheme once all servers have been upgraded to a version which supports it.
Grant-Set Storage Scheme
Under this storage scheme, multiple authorization codes, access tokens, and refresh tokens for a given OAuth 2.0 client and resource owner can be stored within a single CTS entry.
The possible values for this property are:
-
Label: One-to-One Storage Scheme (Value:
CTS_ONE_TO_ONE_MODEL) -
Label: Grant-Set Storage Scheme (Value:
CTS_GRANT_SET_MODEL)Default value:
CTS_ONE_TO_ONE_MODELamsterattribute:storageScheme
-
- Enforce JWT Unreasonable Lifetime
-
Enable the enforcement of JWT token unreasonable lifetime during validation.
The JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants specification states that an authorization server may reject JWTs with an "exp" claim value that is unreasonably far in the future and an "iat" claim value that is unreasonably far in the past. This enforcement may be disabled, but should only be done if the security implications have been evaluated.
Default value:
trueamsterattribute:jwtTokenLifetimeValidationEnabled - JWT Unreasonable Lifetime (seconds)
-
Specify the lifetime (in seconds) of a JWT which should be considered unreasonable and rejected by validation.
The JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants specification states that an authorization server may reject JWTs with an "exp" claim value that is unreasonably far in the future and an "iat" claim value that is unreasonably far in the past. During token validation AM enforces that the token must expire within the specified duration and if the "iat" claim value is present, the token must not be older than the specified duration.
Default value:
86400amsterattribute:jwtTokenUnreasonableLifetime - JWT Required Claims
-
Specify a custom list of claims that will be treated as required during validation of an OAuth 2.0 authorization grant or client authentication JWT. This is in addition to the default mandatory claims, "iss", "aud", and "exp". AM will throw an error if any of the claims defined in this attribute are not present.
This attribute does not apply to a request object JWT, such as the JWT parameter used when invoking the PAR endpoint.
Default value:
[Empty]amsterattribute:jwtTokenRequiredClaims - OAuth2 allow unauthenticated user code entry
-
Determines whether authentication must take place before a user is permitted to proceed to the verification URL to enter a user code.
If set to true, users will be able to input a user code without first logging in.
This setting is intended for backwards compatibility purposes only, and should only be enabled on existing installations that require legacy functionality.
Default value:
falseamsterattribute:allowUnauthorisedAccessToUserCodeForm
Core
The following settings appear on the Core tab:
- Use Client-Side Access & Refresh Tokens
-
When enabled, AM issues access and refresh tokens that can be inspected by resource servers.
This setting can be overridden at the client level. See client profile configuration.
Default value:
falseamsterattribute:statelessTokensEnabled - Use Macaroon Access and Refresh Tokens
-
When enabled, AM will issue access and refresh tokens as Macaroons with caveats.
Default value:
falseamsterattribute:macaroonTokensEnabled - Authorization Code Lifetime (seconds)
-
The time an authorization code is valid for, in seconds.
Default value:
120amsterattribute:codeLifetime - Refresh Token Lifetime (seconds)
-
The time in seconds a refresh token is valid for. If this field is set to
-1, the refresh token will never expire.Default value:
604800amsterattribute:refreshTokenLifetime - Access Token Lifetime (seconds)
-
The time an access token is valid for, in seconds. Note that if you set the value to
0, the access token will not be valid. A maximum lifetime of 600 seconds is recommended.Default value:
3600amsterattribute:accessTokenLifetime - Issue Refresh Tokens
-
Whether to issue a refresh token when returning an access token.
This setting can be overridden at the client level. See client profile configuration.
Default value:
trueamsterattribute:issueRefreshToken - Issue Refresh Tokens on Refreshing Access Tokens
-
Whether to issue a refresh token when refreshing an access token.
This setting can be overridden at the client level. See client profile configuration.
Default value:
trueamsterattribute:issueRefreshTokenOnRefreshedToken - Use Policy Engine for Scope decisions
-
With this setting enabled, the policy engine is consulted for each scope value that is requested.
Scope decisions are made in the following way when based on the policy engine:
-
If a policy returns an action of GRANT=true, the scope is consented automatically, and the user is not consulted in a user-interaction flow.
-
If a policy returns an action of GRANT=false, the scope is not added to any resulting token, and the user will not see it in a user-interaction flow.
-
If no policy returns a value for the GRANT action:
-
For user-facing grant types, such as the authorization or device code flows, the user is asked for consent or saved consent is used.
-
For grant types that are not user-facing, such as those using password or client credentials, the scope is not added to any resulting token.
-
This setting can be overridden at the client level. See client profile configuration.
Default value:
falseamsterattribute:usePolicyEngineForScope -
- Scopes Policy Set
-
The policy set that defines the context in which policy evaluations occur when
Use Policy Engine for Scope decisionsis enabled on the OAuth 2.0 provider. Leave this field blank, or set it tooauth2Scopesto use the default policy set.This setting can be overridden at the client level. See client profile configuration.
Default value:
[Empty] - OAuth2 Access Token May Act Script
-
The script that is executed when issuing an access token explicitly to modify the
may_actclaim placed on the token.This setting can be overridden at the client level. See client profile configuration.
The possible values for this property are:
-
Label: OAuth2 May Act Script (Value:
c735de08-f8f2-4e69-aa4a-2d8d3d438323) -
Label: --- Select a script --- (Value:
[Empty])
Default value:
[Empty]amsterattribute:accessTokenMayActScript -
- OIDC ID Token May Act Script
-
The script that is executed when issuing an OIDC ID Token explicitly to modify the
may_actclaim placed on the token.This setting can be overridden at the client level. See client profile configuration.
The possible values for this property are:
-
Label: OAuth2 May Act Script (Value:
c735de08-f8f2-4e69-aa4a-2d8d3d438323) -
Label: --- Select a script --- (Value:
[Empty])
Default value:
[Empty]amsterattribute:oidcMayActScript -
Advanced
The following settings appear on the Advanced tab:
- Custom Login URL Template
-
Custom URL for handling login, to override the default AM login page.
Supports Freemarker syntax, with the following variables:
Variable
Description
gotoUrlThe URL to redirect to after login.
acrValuesThe Authentication Context Class Reference (acr) values for the authorization request.
realmThe AM realm the authorization request was made on.
moduleThe name of the AM authentication module requested to perform resource owner authentication.
serviceThe name of the AM authentication chain requested to perform resource owner authentication.
localeA space-separated list of locales, ordered by preference.
The following example template redirects users to a non-AM front end to handle login, which will then redirect back to the
/oauth2/authorizeendpoint with any required parameters:http://mylogin.com/login?goto=${goto}<#if acrValues??>&acr_values=${acrValues}</#if><#if realm??>&realm=${realm}</#if><#if module??>&module=${module}</#if><#if service??>&service=${service}</#if><#if locale??>&locale=${locale}</#if>The default AM login page is constructed using the "Base URL Source" service. This setting can be overridden at the client level. See client profile configuration.
amsterattribute:customLoginUrlTemplate - Persistent Claims
-
Set of custom claims that can be persisted between token refreshes. This list should not include the RFC 123 OAuth2 specification defined list of claims.
Default value:
amsterattribute:persistentClaims - Response Type Plugins
-
List of plugins that handle the valid
response_typevalues.OAuth 2.0 clients pass response types as parameters to the OAuth 2.0 Authorization endpoint (
/oauth2/authorize) to indicate which grant type is requested from the provider. For example, the client passescodewhen requesting an authorization code, andtokenwhen requesting an access token.Values in this list take the form
response-type|plugin-class-name.Default value:
code|org.forgerock.oauth2.core.AuthorizationCodeResponseTypeHandler id_token|org.forgerock.openidconnect.IdTokenResponseTypeHandler device_code|org.forgerock.oauth2.core.TokenResponseTypeHandler token|org.forgerock.oauth2.core.TokenResponseTypeHandler
amsterattribute:responseTypeClasses
- Additional Audience Values
-
The additional audience values that will be permitted when verifying Client Authentication JWTs.
These audience values will be in addition to the AS base, issuer and endpoint URIs.
amsterattribute:allowedAudienceValues - Token Exchanger Plugins
-
List of plugins that handle the valid
requested_token_typevalues.When using the Token Exchange grant type, these handlers will be used to convert the provided
subject_tokenandactor_tokeninto the appropriate impersonation or delegation tokens for use with downstream services.Default value:
urn:ietf:params:oauth:token-type:access_token=>urn:ietf:params:oauth:token-type:access_token|org.forgerock.oauth2.core.tokenexchange.accesstoken.AccessTokenToAccessTokenExchanger urn:ietf:params:oauth:token-type:id_token=>urn:ietf:params:oauth:token-type:id_token|org.forgerock.oauth2.core.tokenexchange.idtoken.IdTokenToIdTokenExchanger urn:ietf:params:oauth:token-type:access_token=>urn:ietf:params:oauth:token-type:id_token|org.forgerock.oauth2.core.tokenexchange.accesstoken.AccessTokenToIdTokenExchanger urn:ietf:params:oauth:token-type:id_token=>urn:ietf:params:oauth:token-type:access_token|org.forgerock.oauth2.core.tokenexchange.idtoken.IdTokenToAccessTokenExchanger
amsterattribute:tokenExchangeClasses - Token Validator Plugins
-
List of plugins that validate
subject_tokenandactor_tokenvalues.When using the Token Exchange grant type, these handlers will be used to convert the validate
subject_tokenandactor_tokenvalues to ensure they meet the required criteria to be exchanged.Default value:
urn:ietf:params:oauth:token-type:id_token|org.forgerock.oauth2.core.tokenexchange.idtoken.OidcIdTokenValidator urn:ietf:params:oauth:token-type:access_token|org.forgerock.oauth2.core.tokenexchange.accesstoken.OAuth2AccessTokenValidator
amsterattribute:tokenValidatorClasses - User Profile Attribute(s) the Resource Owner is Authenticated On
-
Names of profile attributes that resource owners use to log in. You can add others to the default, for example
mail.Default value:
uidamsterattribute:authenticationAttributes - User Display Name attribute
-
The profile attribute that contains the name to be displayed for the user on the consent page.
Default value:
cnamsterattribute:displayNameAttribute
- Client Registration Scope Allowlist
-
The set of scopes allowed when registering clients dynamically, with translations.
Scopes may be entered as simple strings or pipe-separated strings representing the internal scope name, locale, and localized description.
For example:
read|en|Permission to view email messages in your accountLocale strings are in the format:
language_country_variant, for exampleen,en_GB, oren_US_WIN.If the locale and pipe is omitted, the description is displayed to all users that have undefined locales.
If the description is also omitted, nothing is displayed on the consent page for the scope. For example specifying
read|would allow the scope read to be used by the client, but would not display it to the user on the consent page when requested.amsterattribute:supportedScopes - Subject Types supported
-
List of subject types supported. Valid values are:
-
public- Each client receives the same subject (sub) value. -
pairwise- Each client receives a different subject (sub) value, to prevent correlation between clients.Default value:
public pairwise
amsterattribute:supportedSubjectTypes
-
- Default Client Scopes
-
List of scopes a client will be granted if they request registration without specifying which scopes they want. Default scopes are NOT auto-granted to clients created through the AM admin UI.
amsterattribute:defaultScopes - OAuth2 Token Signing Algorithm
-
Algorithm used to sign client-side OAuth 2.0 tokens in order to detect tampering.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256.The possible values for this property are:
-
HS256 -
HS384 -
HS512 -
RS256 -
RS384 -
RS512 -
ES256 -
ES384 -
ES512 -
PS256 -
PS384 -
PS512
Default value:
HS256
amsterattribute:tokenSigningAlgorithm -
- Client-Side Token Compression
-
Whether client-side access and refresh tokens should be compressed.
Default value:
falseamsterattribute:tokenCompressionEnabled - Encrypt Client-Side Tokens
-
Whether client-side access and refresh tokens should be encrypted.
Enabling token encryption will disable token signing as encryption is performed using direct symmetric encryption.
This setting can be overridden at the client level. See client profile configuration.
Default value:
falseamsterattribute:tokenEncryptionEnabled - Subject Identifier Hash Salt
-
If pairwise subject types are supported, it is STRONGLY RECOMMENDED to change this value. It is used in the salting of hashes for returning specific
subclaims to individuals using the samerequest_uriorsector_identifier_uri.Default value:
changemeamsterattribute:hashSalt - Code Verifier Parameter Required
-
If enabled, requests using the authorization code grant or device flow require a
code_challengeattribute to comply with the PKCE standard.For more information, read the PKCE specification.
Note that if a client specifies a
code_challengeparameter in the authorization request, PKCE is enabled regardless of the value of this attribute.The possible values for this property are:
-
Label: All requests (Value:
true) -
Label: Requests from all public clients (Value:
public) -
Label: Requests from all passwordless public clients (Value:
passwordless) -
Label: No requests (Value:
false)
Default value:
falseamsterattribute:codeVerifierEnforced -
- Modified Timestamp Attribute Name
-
The identity Data Store attribute used to return modified timestamp values.
This attribute is paired together with the Created Timestamp Attribute Name attribute (
createdTimestampAttribute). You can leave both attributes unset (default) or set them both. If you set only one attribute and leave the other blank, the access token fails with a 500 error.For example, when you configure AM as an OpenID Connect Provider in a Mobile Connect application and use DS as an identity data store, the client accesses the
userinfoendpoint to obtain theupdated_atclaim value in the ID token. Theupdated_atclaim obtains its value from themodifiedTimestampAttributeattribute in the user profile. If the profile has never been modified theupdated_atclaim uses thecreatedTimestampAttributeattribute.amsterattribute:modifiedTimestampAttribute - Created Timestamp Attribute Name
-
The identity Data Store attribute used to return created timestamp values.
amsterattribute:createdTimestampAttribute - Password Grant Authentication Service
-
The authentication service (chain or tree) that will be used to authenticate the username and password for the resource owner password credentials grant type.
The possible values for this property are:
-
[Empty] -
ldapService -
amsterService -
Example -
Agent -
RetryLimit -
PersistentCookie -
HmacOneTimePassword -
Facebook-ProvisionIDMAccount -
Google-AnonymousUser -
Google-DynamicAccountCreation -
PlatformRegistration -
PlatformProgressiveProfile -
PlatformLogin -
PlatformForgottenUsername -
PlatformResetPassword -
PlatformUpdatePassword
amsterattribute:passwordGrantAuthService -
- Enable Auth Module Messages for Password Credentials Grant
-
If enabled, authentication module failure messages are used to create Resource Owner Password Credentials Grant failure messages. If disabled, a standard authentication failed message is used.
The Password Grant Type requires the
grant_type=passwordparameter.Default value:
falseamsterattribute:moduleMessageEnabledInPasswordGrant - Grant Types
-
The set of Grant Types (OAuth2 Flows) that are permitted to be used by this client.
If no Grant Types (OAuth2 Flows) are configured nothing will be permitted.
Default value:
implicit urn:ietf:params:oauth:grant-type:saml2-bearer refresh_token password client_credentials urn:ietf:params:oauth:grant-type:device_code authorization_code urn:openid:params:grant-type:ciba urn:ietf:params:oauth:grant-type:uma-ticket urn:ietf:params:oauth:grant-type:token-exchange urn:ietf:params:oauth:grant-type:jwt-bearer
amsterattribute:grantTypes - Trusted TLS Client Certificate Header
-
HTTP Header to receive TLS client certificates when TLS is terminated at a proxy.
Leave blank if not terminating TLS at a proxy. Ensure that the proxy is configured to strip this headerfrom incoming requests. Best practice is to use a random string.
amsterattribute:tlsClientCertificateTrustedHeader - TLS Client Certificate Header Format
-
Format of the HTTP header used to communicate a client certificate from a reverse proxy.
The following formats are supported:
-
URLENCODED_PEM- a URL-encoded PEM format certificate. This is the format used by Nginx. -
` X_FORWARDED_CLIENT_CERT` - the X-Forwarded-Client-Certformat used by Envoy and Istio.
The possible values for this property are:
-
URLENCODED_PEM -
X_FORWARDED_CLIENT_CERT
Default value:
URLENCODED_PEM
amsterattribute:tlsClientCertificateHeaderFormat -
- Support TLS Certificate-Bound Access Tokens
-
Whether to bind access tokens to the client certificate when using TLS client certificate authentication.
Default value:
trueamsterattribute:tlsCertificateBoundAccessTokensEnabled - Check TLS Certificate Revocation Status
-
Whether to check if TLS client certificates have been revoked.
If enabled then AM will check if TLS client certificates used for client authentication have been revoked using either OCSP (preferred) or CRL. AM implements "soft fail" semantics: if the revocation status cannot be established due to a temporary error (e.g., network error) then the certificate is assumed to still be valid.
Default value:
falseamsterattribute:tlsCertificateRevocationCheckingEnabled - OCSP Responder URI
-
URI of the OCSP responder service to use for checking certificate revocation status.
If specified this value overrides any OCSP or CRL mechanisms specified in individual certificates.
amsterattribute:tlsOcspResponderUri - OCSP Responder Certificate
-
PEM-encoded certificate to use to verify OCSP responses.
If specified this certificate will be used to verify the signature on all OCSP responses. Otherwise the appropriate certificate will be determined from the trusted CA certificates.
amsterattribute:tlsOcspResponderCert - Macaroon Token Format
-
The format to use when serializing and parsing Macaroons. V1 is bulky and should only be used when compatibility with older Macaroon libraries is required.
The possible values for this property are:
-
V1 -
V2
Default value:
V2
amsterattribute:macaroonTokenFormat -
- Require exp claim in Request Object
-
If enabled, the
expclaim must be included in JWT request objects specified at /oauth2/authorize or /oauth2/par.The
exp(expiration time) claim defines the lifetime of the JWT, after which the JWT is no longer valid.To comply with the FAPI security profile, this setting must be enabled.
Default value:
falseamsterattribute:expClaimRequiredInRequestObject - Require nbf claim in Request Object
-
If enabled, the
nbfclaim must be included in JWT request objects specified at /oauth2/authorize or /oauth2/par.The
nbf(not before) claim defines the earliest time that the JWT can be accepted for processing.To comply with the FAPI security profile, this setting must be enabled.
Default value:
falseamsterattribute:nbfClaimRequiredInRequestObject - Max nbf and exp difference
-
The maximum permitted difference, in minutes, between the
nbfandexpclaims, as defined in the request object JWT.A value of 0 indicates that there is no maximum time requirement.
If set to a value greater than 0, and either
nbforexpis not defined, the JWT is validated successfully, providing the claims are not required.If set to a value greater than 0, and both claims are present, the JWT is validated accordingly, even when not required.
To comply with the FAPI security profile, this setting must be 60 (minutes) or less.
Default value:
0amsterattribute:maxDifferenceBetweenRequestObjectNbfAndExp - Max nbf age
-
The maximum permitted age, in minutes, of the
nbfclaim.A value of 0 indicates that there is no maximum time requirement.
If set to a value greater than 0, and
nbfis neither required nor specified, the JWT is validated successfully.If set to a value greater than 0, and
nbfis present, the JWT is validated accordingly, even when not required.To comply with the FAPI security profile, this setting must be 60 (minutes) or less.
Default value:
0amsterattribute:maxAgeOfRequestObjectNbfClaim
- Request Object Processing Specification
-
For OpenID Connect requests only, this setting determines which specification is used to validate request object JWTs.
For example, the following OpenID Connect request specifies a request object JWT, and could be validated either according to the JAR specification, or as a standard OpenID Connect request:
/authorize?client_id=myClient&request={JWT with scope=openid, response_type=id_token}OAuth 2.0 requests that do not fall into this category, such as PAR, or non-OpenID Connect JWT requests, are processed according to the JAR specification, regardless of the value of this setting.
The possible values are:
-
OIDC- to adhere to the OIDC specification for JWT processing -
JAR- to adhere to the JAR specification for JWT processing
This table summarizes the differences between the rules that need to be adhered to in each case.
Specification Rules OIDC specification JAR specification Request object
May be unsigned.
Authorization request parameters
Assembles parameters from both the request object and the query parameters.
If duplicates exist, the request object parameter takes precedence.
Assembles parameters from the request object ONLY.
Duplicates that are defined as query parameters are ignored.
Required request parameters
-
client_id -
response_type -
scope, includingopenidscope value
-
client_id(must match the client ID specified in the request itself) -
requestORrequest_uri
Default value:
OIDCamsterattribute:requestObjectProcessing -
- PAR Request URI Lifetime (seconds)
-
The length of time that the PAR Request URI is valid, in seconds.
It is strongly recommended to set this value to a short interval; for example, between 5 and 150 seconds. Setting this attribute to a higher value increases the load on the CTS, and may even result in denial of service if the requests are large and consume the available storage capacity.
For information about the PAR flow, see Authorization code grant with PAR.
Default value:
90amsterattribute:parRequestUriLifetime - Require Pushed Authorization Requests
-
If enabled, clients must use the PAR endpoint to initiate authorization requests, otherwise AM will throw an error indicating a missing or invalid request object.
This applies to all clients, including clients that are not configured to require PAR. See Advanced client properties for details.
Default value:
falseamsterattribute:requirePushedAuthorizationRequests
- Refresh Token Grace Period (seconds)
-
The time, in seconds, that a refresh token can be reused. This grace period lets OAuth 2.0 clients recover seamlessly, if the response from an original refresh token request is not received, because of a network problem or other transient issue. During the grace period, the refresh token can be reused multiple times, if the network problem persists. When the grace period ends, the refresh token is revoked.
The refresh token grace period applies only to server-side tokens, in a one-to-one storage scheme.
Having a long grace period poses a security risk. You should therefore keep the grace period as small as possible. By default, the grace period cannot exceed 120 seconds. You can override this default maximum by setting the org.forgerock.openam.oauth2.client.graceperiod.disabled advanced server property. Note, however, that exceeding the default maximum of 120 seconds is not recommended. There is no grace period by default, so the default value is
0.
- Allow Client Credentials in Token Endpoint Query Parameters
-
When this setting is
true, you can include client credentials in token endpoint requests as query parameters.Default value:
falseFor security reasons, you shouldn’t change this setting. amsterattribute:allowClientCredentialsInTokenRequestQueryParameters
Client Dynamic Registration
The following settings appear on the Client Dynamic Registration tab:
- Require Software Statement for Dynamic Client Registration
-
When enabled, a software statement JWT containing at least the
iss(issuer) claim must be provided when registering an OAuth 2.0 client dynamically.Default value:
falseamsterattribute:dynamicClientRegistrationSoftwareStatementRequired - Required Software Statement Attested Attributes
-
The client attributes that are required to be present in the software statement JWT when registering an OAuth 2.0 client dynamically. Only applies if Require Software Statements for Dynamic Client Registration is enabled.
Leave blank to allow any attributes to be present.
Default value:
redirect_urisamsterattribute:requiredSoftwareStatementAttestedAttributes - Allow Open Dynamic Client Registration
-
Allow clients to register without an access token. If enabled, you should consider adding some form of rate limiting. For more information, see Client Registration in the OpenID Connect specification.
Default value:
falseamsterattribute:allowDynamicRegistration - Generate Registration Access Tokens
-
Whether to generate Registration Access Tokens for clients that register by using open dynamic client registration. Such tokens let the client access the Client Configuration Endpoint as per the OpenID Connect specification. This setting has no effect if Allow Open Dynamic Client Registration is disabled.
Default value:
trueamsterattribute:generateRegistrationAccessTokens - Scope to give access to dynamic client registration
-
Mandatory scope required when registering a new OAuth2 client.
Default value:
dynamic_client_registrationamsterattribute:dynamicClientRegistrationScope
OpenID Connect
The following settings appear on the OpenID Connect tab:
- Overrideable Id_Token Claims
-
List of claims in the ID token that can be overridden in the OIDC Claims script. These should be the subset of the core OpenID Connect Claims like
audorazp.-
For information about the core OpenID Connect claims, see the ID Token data structure.
-
For details of the OIDC script and how to implement a custom scripted plugin, see OIDC user info claims.
-
To override claims, follow the steps described in How do I override claims in the OIDC ID token in Identity Cloud or AM 7.1.x?
This setting can be overridden at the client level. See client profile configuration.
amsterattribute:overrideableOIDCClaims -
- ID Token Signing Algorithms supported
-
Algorithms supported to sign OpenID Connect
id_tokens.AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256. -
RS384- RSASSA-PKCS-v1_5 using SHA-384. -
RS512- RSASSA-PKCS-v1_5 using SHA-512. -
PS256- RSASSA-PSS using SHA-256. -
PS384- RSASSA-PSS using SHA-384. -
PS512- RSASSA-PSS using SHA-512.Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedIDTokenSigningAlgorithms -
- ID Token Encryption Algorithms supported
-
Encryption algorithms supported to encrypt OpenID Connect ID tokens in order to hide its contents.
AM supports the following ID token encryption algorithms:
-
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
` RSA-OAEP-256` - RSA with OAEP with SHA-256 and MGF-1.
-
` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.
-
` RSA1_5` - RSA with PKCS#1 v1.5 padding.
-
` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.
-
` dir` - Direct encryption with AES using the hashed client secret.
-
` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW RSA-OAEP ECDH-ES+A128KW RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedIDTokenEncryptionAlgorithms
-
- ID Token Encryption Methods supported
-
Encryption methods supported to encrypt OpenID Connect ID tokens in order to hide its contents.
AM supports the following ID token encryption algorithms:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedIDTokenEncryptionMethods
-
- Supported Claims
-
Set of claims supported by the OpenID Connect
/oauth2/userinfoendpoint, with translations.Claims may be entered as simple strings or pipe separated strings representing the internal claim name, locale, and localized description.
For example:
name|en|Your full name..Locale strings are in the format:
language + "" + country + "" + variant, for exampleen,en_GB, oren_US_WIN. If the locale and pipe is omitted, the description is displayed to all users that have undefined locales.If the description is also omitted, nothing is displayed on the consent page for the claim. For example specifying
family_name|would allow the claimfamily_nameto be used by the client, but would not display it to the user on the consent page when requested.amsterattribute:supportedClaims - OpenID Connect JWT Token Lifetime (seconds)
-
The period of time the JWT is valid, in seconds.
Default value:
3600Don’t set a token lifetime greater than 86400 seconds (one day). amsterattribute:jwtTokenLifetime - OIDC Provider Discovery
-
Turns on and off OIDC Discovery endpoint.
Default value:
falseamsterattribute:oidcDiscoveryEndpointEnabled
Advanced OpenID Connect
The following settings appear on the Advanced OpenID Connect tab:
- Remote JSON Web Key URL
-
The Remote URL where the providers JSON Web Key can be retrieved.
If this setting is not configured, then AM provides a local URL to access the public key of the private key used to sign ID tokens.
amsterattribute:jkwsURI - Idtokeninfo Endpoint Requires Client Authentication
-
When enabled, the
/oauth2/idtokeninfoendpoint requires client authentication if the signing algorithm is set toHS256,HS384, orHS512.Default value:
trueamsterattribute:idTokenInfoClientAuthenticationEnabled - Enable "claims_parameter_supported"
-
If enabled, clients will be able to request individual claims using the
claimsrequest parameter, as per section 5.5 of the OpenID Connect specification.Default value:
falseamsterattribute:claimsParameterSupported - OpenID Connect acr_values to Auth Chain Mapping
-
Maps OpenID Connect ACR values to authentication chains. For more details, see the acr_values parameter in the OpenID Connect authentication request specification.
amsterattribute:loaMapping - Default ACR values
-
Default requested Authentication Context Class Reference values.
List of strings that specifies the default acr values that the OP is being requested to use for processing requests from this Client, with the values appearing in order of preference. The Authentication Context Class satisfied by the authentication performed is returned as the acr Claim Value in the issued ID Token. The acr Claim is requested as a Voluntary Claim by this parameter. The acr_values_supported discovery element contains a list of the acr values supported by this server. Values specified in the acr_values request parameter or an individual acr Claim request override these default values.
amsterattribute:defaultACR - OpenID Connect id_token amr Values to Auth Module Mappings
-
Specify
amrvalues to be returned in the OpenID Connectid_token. Once authentication has completed, the authentication modules that were used from the authentication service will be mapped to theamrvalues. If you do not requireamrvalues, or are not providing OpenID Connect tokens, leave this field blank.amsterattribute:amrMappings - Always Return Claims in ID Tokens
-
If enabled, include scope-derived claims in the
id_token, even if an access token is also returned that could provide access to get the claims from theuserinfoendpoint.If not enabled, if an access token is requested the client must use it to access the
userinfoendpoint for scope-derived claims, as they will not be included in the ID token.Default value:
falseamsterattribute:alwaysAddClaimsToToken - Enable Session Management
-
If this is not enabled then OpenID Connect session management related endpoints will be disabled. When enabled AM will store ops tokens corresponding to OpenID Connect sessions in the CTS store and an oidc session id in the AM session.
Default value:
trueamsterattribute:storeOpsTokens - Request Parameter Signing Algorithms Supported
-
Algorithms supported to verify signature of Request parameter. AM supports the signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256.
Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedRequestParameterSigningAlgorithms -
- Request Parameter Encryption Algorithms Supported
-
Encryption algorithms supported to decrypt Request parameter.
AM supports the following ID token encryption algorithms:
-
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
RSA-OAEP-256- RSA with OAEP with SHA-256 and MGF-1. -
A128KW- AES Key Wrapping with 128-bit key derived from the client secret. -
RSA1_5- RSA with PKCS#1 v1.5 padding. -
A256KW- AES Key Wrapping with 256-bit key derived from the client secret. -
dir- Direct encryption with AES using the hashed client secret. -
A192KW- AES Key Wrapping with 192-bit key derived from the client secret.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW ECDH-ES+A128KW RSA-OAEP RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedRequestParameterEncryptionAlgorithms -
- Request Parameter Encryption Methods Supported
-
Encryption methods supported to decrypt Request parameter.
AM supports the following Request parameter encryption algorithms:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedRequestParameterEncryptionEnc -
- Supported Token Endpoint JWS Signing Algorithms.
-
Supported JWS Signing Algorithms for 'private_key_jwt' JWT-based authentication method.
Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedTokenEndpointAuthenticationSigningAlgorithms - Authorized OIDC SSO Clients
-
Clients authorized to use OpenID Connect ID tokens as SSO Tokens.
Allows clients to act with the full authority of the user. Grant this permission only to trusted clients.
amsterattribute:authorisedOpenIdConnectSSOClients - UserInfo Signing Algorithms Supported
-
Algorithms supported to verify signature of the UserInfo endpoint. AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256.
Default value:
ES384 HS256 HS512 ES256 RS256 HS384 ES512
amsterattribute:supportedUserInfoSigningAlgorithms -
- UserInfo Encryption Algorithms Supported
-
Encryption algorithms supported by the UserInfo endpoint.
AM supports the following UserInfo endpoint encryption algorithms:
-
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
` RSA-OAEP-256` - RSA with OAEP with SHA-256 and MGF-1.
-
` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.
-
` RSA1_5` - RSA with PKCS#1 v1.5 padding.
-
` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.
-
` dir` - Direct encryption with AES using the hashed client secret.
-
` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW RSA-OAEP ECDH-ES+A128KW RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedUserInfoEncryptionAlgorithms -
- UserInfo Encryption Methods Supported
-
Encryption methods supported by the UserInfo endpoint.
AM supports the following UserInfo endpoint encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedUserInfoEncryptionEnc -
- Token Introspection Response Signing Algorithms Supported
-
Algorithms that are supported for signing the Token Introspection endpoint JWT response.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256. -
RS384- RSASSA-PKCS-v1_5 using SHA-384. -
RS512- RSASSA-PKCS-v1_5 using SHA-512. -
EdDSA- EdDSA with SHA-512.
Default value:
PS384 RS384 EdDSA ES384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedTokenIntrospectionResponseSigningAlgorithms -
- Token Introspection Response Encryption Algorithms Supported
-
Encryption algorithms supported by the Token Introspection endpoint JWT response.
AM supports the following Token Introspection endpoint encryption algorithms:
-
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
RSA-OAEP-256- RSA with OAEP with SHA-256 and MGF-1. -
A128KW- AES Key Wrapping with 128-bit key derived from the client secret. -
RSA1_5- RSA with PKCS#1 v1.5 padding. -
A256KW- AES Key Wrapping with 256-bit key derived from the client secret. -
dir- Direct encryption with AES using the hashed client secret. -
A192KW- AES Key Wrapping with 192-bit key derived from the client secret.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW RSA-OAEP ECDH-ES+A128KW RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedTokenIntrospectionResponseEncryptionAlgorithms -
- Token Introspection Response Encryption Methods Supported
-
Encryption methods supported by the Token Introspection endpoint JWT response.
AM supports the following encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedTokenIntrospectionResponseEncryptionEnc -
- Authorization Response Signing Algorithms Supported
-
Algorithms supported for signing the /oauth2/authorize endpoint JWT response.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256 -
HS384- HMAC with SHA-384 -
HS512- HMAC with SHA-512 -
RS256- RSASSA-PKCS-v1_5 using SHA-256 -
RS384- RSASSA-PKCS1-v1_5 using SHA-384 -
RS512- RSASSA-PKCS1-v1_5 using SHA-512 -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve -
PS256- RSASSA-PSS using SHA-256 and MGF1 with SHA-256 -
PS384- RSASSA-PSS using SHA-384 and MGF1 with SHA-384 -
PS512- RSASSA-PSS using SHA-512 and MGF1 with SHA-512
Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedAuthorizationResponseSigningAlgorithms -
- Authorization Response Encryption Algorithms Supported
-
Algorithms supported for encrypting the /oauth2/authorize JWT response.
AM supports the following Token Introspection endpoint encryption algorithms:
-
RSA1_5- RSA with PKCS#1 v1.5 padding. -
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
RSA-OAEP-256- RSA with OAEP with SHA-256 and MGF-1. -
A128KW- AES Key Wrapping with 128-bit key derived from the client secret. -
A192KW- AES Key Wrapping with 192-bit key derived from the client secret. -
A256KW- AES Key Wrapping with 256-bit key derived from the client secret. -
dir- Direct encryption with AES using the hashed client secret. -
ECDH-ES- Elliptic Curve Diffie-Hellman Ephemeral Static key agreement using Concat KDF. -
ECDH-ES+A128KW- ECDH-ES using Concat KDF and CEK wrapped withA128KW. -
ECDH-ES+A192KW- ECDH-ES using Concat KDF and CEK wrapped withA192KW. -
ECDH-ES+A256KW- ECDH-ES using Concat KDF and CEK wrapped withA256KW.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW RSA-OAEP ECDH-ES+A128KW RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedAuthorizationResponseEncryptionAlgorithms -
- Authorization Response Encryption Methods Supported
-
Methods supported for encrypting the /oauth2/authorize JWT response.
AM supports the following encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedAuthorizationResponseEncryptionEnc -
- Include all kty and alg combinations in jwks_uri
-
By default only distinct kid entries are returned in the jwks_uri and the alg property is not included. Enabling this flag will result in duplicate kid entries, each one specifying a different kty and alg combination (RFC7517 distinct key KIDs).
Default value:
falseamsterattribute:includeAllKtyAlgCombinationsInJwksUri - Use Force Authentication for
prompt=login -
This setting is applied only when you’ve implemented modules or chains, and you’ve specified the
prompt=loginparameter.Default value:
false.When set to
false, AM forces the end user to authenticate even if they already have a valid session. After reauthentication, AM creates a new session.When set to
true, AM forces the end user to authenticate even if they already have a valid session; however, after reauthentication, AM returns the same session ID.If you set Use Force Authentication for prompt=logintotrue, you must also set theorg.forgerock.openam.authentication.forceAuth.enabledadvanced server property totrue. If you do not do this, your users may end up in an infinite login loop.For security reasons, it is strongly recommended that you leave
Use Force Authentication for prompt=loginset to the default value (false), so that a new session is created when the user reauthenticates. - Use Force Authentication for max_age
-
This setting applies only to reauthentication that is triggered by the Default Max Age property of an OAuth 2.0 client.
Default value:
false.When set to
false:-
If the user requests authorization after the
max_agehas passed, AM destroys the existing session and starts a reauthentication process. -
Reauthentication triggered by the
max_agecreates a new session.
When set to
true:-
If the user requests authorization after the
max_agehas passed, AM does not destroy the existing session. -
Reauthentication triggered by the
max_agereturns a new session.If you set Use Force Authentication for max_agetotrue, you must also set theorg.forgerock.openam.authentication.forceAuth.enabledadvanced server property totrue. If you do not do this, your users may end up in an infinite login loop.
For security reasons, it is strongly recommended that you leave
Use Force Authentication for max_ageset to the default value (false), so that a new session is created when the user reauthenticates. -
Device Flow
The following settings appear on the Device Flow tab:
- Verification URL
-
The URL that the user will be instructed to visit to complete their OAuth 2.0 login and consent when using the device code flow.
amsterattribute:verificationUrl - Device Completion URL
-
The URL that the user will be sent to on completion of their OAuth 2.0 login and consent when using the device code flow.
amsterattribute:completionUrl - Device Code Lifetime (seconds)
-
The lifetime of the device code, in seconds.
Default value:
300amsterattribute:deviceCodeLifetime - Device Polling Interval
-
The polling frequency for devices waiting for tokens when using the device code flow.
Default value:
5amsterattribute:devicePollInterval - User Code Character Length
-
The number of characters in the generated user code.
Default value:
8amsterattribute:deviceUserCodeLength - User Code Character Set
-
The set of characters to be used to generate a user code.
Consider limitations of low resolution mobile devices when defining a character sets. For example, the OAuth 2.0 Device Grant specification recommends removing characters that can be easily confused, such as "0" and "O" or "1", "l" and "I". See RFC 8628 for further examples.
Default value:
234567ACDEFGHJKLMNPQRSTWXYZabcdefhijkmnopqrstwxyzamsterattribute:deviceUserCodeCharacterSet
Consent
The following settings appear on the Consent tab:
- Saved Consent Attribute Name
-
Name of a multi-valued attribute on resource owner profiles where AM can save authorization consent decisions.
When the resource owner chooses to save the decision to authorize access for a client application, then AM updates the resource owner’s profile to avoid having to prompt the resource owner to grant authorization when the client issues subsequent authorization requests.
amsterattribute:savedConsentAttribute - Allow Clients to Skip Consent
-
If enabled, clients may be configured so that the resource owner will not be asked for consent during authorization flows.
This setting can be overridden at the client level. See client profile configuration.
Default value:
falseamsterattribute:clientsCanSkipConsent - Enable Remote Consent
-
Enables consent to be gathered by a separate service.
This setting can be overridden at the client level. See client profile configuration.
Default value:
falseamsterattribute:enableRemoteConsent - Remote Consent Service ID
-
The ID of an existing remote consent service agent.
The possible values for this property are:
-
[Empty]This setting can be overridden at the client level. See client profile configuration.
amsterattribute:remoteConsentServiceId
-
- Remote Consent Service Request Signing Algorithms Supported
-
Algorithms supported to sign consent_request JWTs for Remote Consent Services.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256.Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedRcsRequestSigningAlgorithms
-
- Remote Consent Service Request Encryption Algorithms Supported
-
Encryption algorithms supported to encrypt Remote Consent Service requests.
AM supports the following encryption algorithms:
-
RSA1_5- RSA with PKCS#1 v1.5 padding. -
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
RSA-OAEP-256- RSA with OAEP with SHA-256 and MGF-1. -
A128KW- AES Key Wrapping with 128-bit key derived from the client secret. -
A192KW- AES Key Wrapping with 192-bit key derived from the client secret. -
A256KW- AES Key Wrapping with 256-bit key derived from the client secret. -
dir- Direct encryption with AES using the hashed client secret.Default value:
ECDH-ES+A256KW ECDH-ES+A192KW RSA-OAEP ECDH-ES+A128KW RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedRcsRequestEncryptionAlgorithms
-
- Remote Consent Service Request Encryption Methods Supported
-
Encryption methods supported to encrypt Remote Consent Service requests.
AM supports the following encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedRcsRequestEncryptionMethods
-
- Remote Consent Service Response Signing Algorithms Supported
-
Algorithms supported to verify signed consent_response JWT from Remote Consent Services.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256.Default value:
PS384 ES384 RS384 HS256 HS512 ES256 RS256 HS384 ES512 PS256 PS512 RS512
amsterattribute:supportedRcsResponseSigningAlgorithms
-
- Remote Consent Service Response Encryption Algorithms Supported
-
Encryption algorithms supported to decrypt Remote Consent Service responses.
AM supports the following encryption algorithms:
-
RSA1_5- RSA with PKCS#1 v1.5 padding. -
` RSA-OAEP` - RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1.
-
` RSA-OAEP-256` - RSA with OAEP with SHA-256 and MGF-1.
-
` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.
-
` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.
-
` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.
-
` dir` - Direct encryption with AES using the hashed client secret.
Default value:
ECDH-ES+A256KW ECDH-ES+A192KW ECDH-ES+A128KW RSA-OAEP RSA-OAEP-256 A128KW A256KW ECDH-ES dir A192KW
amsterattribute:supportedRcsResponseEncryptionAlgorithms
-
- Remote Consent Service Response Encryption Methods Supported
-
Encryption methods supported to decrypt Remote Consent Service responses.
AM supports the following encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.Default value:
A256GCM A192GCM A128GCM A128CBC-HS256 A192CBC-HS384 A256CBC-HS512
amsterattribute:supportedRcsResponseEncryptionMethods
-
CIBA
The following settings appear on the CIBA tab:
- Back Channel Authentication ID Lifetime (seconds)
-
The time back channel authentication request id is valid for, in seconds.
Default value:
600amsterattribute:cibaAuthReqIdLifetime - Polling Wait Interval (seconds)
-
The minimum amount of time in seconds that the Client should wait between polling requests to the token endpoint
Default value:
2amsterattribute:cibaMinimumPollingInterval - Signing Algorithms Supported
-
Algorithms supported to sign the CIBA request parameter.
AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:
-
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
PS256- RSASSA-PSS using SHA-256.Default value:
ES256 PS256
amsterattribute:supportedCibaSigningAlgorithms
-
Plugins
The Plugins settings are used to configure the following supported OAuth2 plugin extension points:
-
Access Token Modification
-
OIDC Claims
-
Scope Evaluation
-
Scope Validation
-
Authorize Endpoint Data Provider
Each plugin is configured using three different attributes:
-
Plugin Type:This value can be either
SCRIPTEDto run a custom script, orJAVAfor a custom implementation class. -
Script:The script that is run for
SCRIPTEDplugin types. -
Implementation Class:The class that is invoked for
JAVAplugin types. The class must implement the appropriate Java interface in theorg.forgerock.oauth2.core.pluginspackage for the plugin.These plugin settings can be overridden at the client level. See OAuth 2.0 provider overrides.
The following settings appear on the Plugins tab:
- Access Token Modification Plugin Type
-
Default value:
SCRIPTEDamsterattribute:accessTokenModificationPluginType - Access Token Modification Script
-
This script is run when issuing an access token. The script lets you modify the token, for example, by altering the data fields, before it is persisted or returned to the client.
The script is run if
Access Token Modification Plugin Typeis set toSCRIPTED.Default value:
OAuth2 Access Modification Scriptamsterattribute:accessTokenModificationScript - Access Token Modifier Plugin Implementation Class
-
The Java class that provides the custom implementation for the access token modifier plugin interface,
org.forgerock.oauth2.core.plugins.AccessTokenModifier. This class is invoked whenAccess Token Modification Plugin Typeis set toJAVA.Default value:
[Empty]amsterattribute:accessTokenModificationClass - OIDC Claims Plugin Type
-
Default value:
SCRIPTEDamsterattribute:oidcClaimsPluginType - OIDC Claims Script
-
This script is run when issuing an ID token or during a request to the
/userinfoOpenID Connect endpoint. Use this script to retrieve claim values based on an issued access token.The script is run if
OIDC Claims Plugin Typeis set toSCRIPTED.Default value:
OIDC Claims Scriptamsterattribute:oidcClaimsScript - OIDC Claims Plugin Implementation Class
-
The Java class that provides the custom implementation for the OIDC claims plugin interface,
org.forgerock.oauth2.core.plugins.UserInfoClaimsPlugin. This class is invoked whenOIDC Claims Plugin Typeis set toJAVA.Default value:
[Empty]amsterattribute:oidcClaimsClass - Scope Evaluation Plugin Type
-
Default value:
JAVAamsterattribute:evaluateScopePluginType - Scope Evaluation Script
-
This script retrieves and evaluates the scope information for an OAuth2 access token.
The script lets you populate the scopes with profile attribute values. For example, if one of the scopes is
mail, AM setsmailto the resource owner’s email address in the token information returned.Default value:
--- Select a script ---amsterattribute:evaluateScopeScript - Scope Evaluation Plugin Implementation Class
-
The Java class that provides the custom implementation for the evaluate scope plugin interface: org.forgerock.oauth2.core.plugins.ScopeEvaluator.
Default value:
org.forgerock.oauth2.core.plugins.registry.DefaultScopeEvaluatoramsterattribute:evaluateScopeClass - Scope Validation Plugin Type
-
Default value:
JAVAamsterattribute:validateScopePluginType - Scope Validation Script
-
This script validates and customizes the set of requested scopes for authorize, access token, refresh token, and back channel authorize requests.
Default value:
--- Select a script ---amsterattribute:validateScopeScript - Scope Validation Plugin Implementation Class
-
The Java class that provides the custom implementation for the evaluate scope plugin interface: org.forgerock.oauth2.core.plugins.ScopeValidator.
Default value:
org.forgerock.oauth2.core.plugins.registry.DefaultScopeValidatoramsterattribute:validateScopeClass - Authorize Endpoint Data Provider Plugin Type
-
Default value:
JAVAamsterattribute:authorizeEndpointDataProviderPluginType - Authorize Endpoint Data Provider Script
-
Use this script to retrieve additional data from an authorization request, such as data from the user’s session or from an external service.
Default value:
--- Select a script ---amsterattribute:authorizeEndpointDataProviderScript - Authorize Endpoint Data Provider Plugin Implementation Class
-
The Java class that provides the custom implementation for the evaluate scope plugin interface: org.forgerock.oauth2.core.plugins.AuthorizeEndpointDataProvider.
Default value:
org.forgerock.oauth2.core.plugins.registry.DefaultEndpointDataProvideramsterattribute:authorizeEndpointDataProviderClass - Access Token Enricher Plugin Implementation Class
-
The class that provides the custom implementation for the access token enricher plugin interface.
The access token enricher plugin interface is deprecated and will be removed in a future release.
Default value:
org.forgerock.oauth2.core.plugins.registry.DefaultAccessTokenEnricheramsterattribute:accessTokenEnricherClass - Device Code Flow User Code Generator Implementation Class
-
The class that provides the custom implementation for generating user codes for the device code flow.
To override the default implementation, create a Java class that implements the
UserCodeGeneratorinterface, and set this property to the fully qualified class name.Default value:
org.forgerock.oauth2.core.plugins.registry.DefaultUserCodeGeneratoramsterattribute:userCodeGeneratorClass
Platform
amster service name: Platform
The following settings are available in this service:
- Platform Locale
-
Set the fallback locale used when the user locale cannot be determined.
Default value:
en_USamsterattribute:locale
Policy configuration
amster service name: PolicyConfiguration
Global attributes
The following settings appear on the Global Attributes tab:
- Resource Comparator
-
AM uses resource comparators to match resources specified in policy rules. When setting comparators on the command line, separate fields with
|characters.Default value:
serviceType=iPlanetAMWebAgentService|class=com.sun.identity.policy.plugins.HttpURLResourceName|wildcard=|oneLevelWildcard=--|delimiter=/|caseSensitive=falseamsterattribute:resourceComparators - Continue Evaluation on Deny Decision
-
If no, then AM stops evaluating policy as soon as it reaches a deny decision.
Default value:
falseamsterattribute:continueEvaluationOnDeny - Realm Alias Referrals
-
If yes, then AM allows creation of policies for HTTP and HTTPS resources whose FQDN matches the DNS alias for the realm even when no referral policy exists.
Default value:
falseamsterattribute:realmAliasReferrals
Realm defaults
The following settings appear on the Realm Defaults tab:
- Primary LDAP Server
-
Configuration directory server host:port that AM searches for policy information. The default value is the directory server specified during setup.
Configure the directory server settings if you want to use an external identity store in an LDAP filter condition in a policy.
These LDAP settings are only applicable to the identity repository of the LDAP accounts or groups used in the filter condition, and do not affect how other data, such as policies or policy subjects, is stored.
Format:
local AM server name | hostname:portMultiple entries must be prefixed by local server name. Make sure to place the multiple entries on a single line and separate the hostname:port URLs with a space.
For example, openam.example.com|opendj.example.com:1389 opendj.example.com:2389
Default value:
openam.example.com:50636amsterattribute:ldapServer - LDAP Users Base DN
-
Base DN for LDAP Users subject searches.
Default value:
dc=openam,dc=forgerock,dc=orgamsterattribute:usersBaseDn - LDAP Bind DN
-
Bind DN to connect to the directory server for policy information.
Default value:
cn=Directory Manageramsterattribute:bindDn - LDAP Bind Password
-
Bind password to connect to the directory server for policy information.
amsterattribute:bindPassword - LDAP Organization Search Filter
-
Search filter to match organization entries.
Default value:
(objectclass=sunismanagedorganization)amsterattribute:realmSearchFilter - LDAP Users Search Filter
-
Search filter to match user entries.
Default value:
(objectclass=inetorgperson)amsterattribute:usersSearchFilter - LDAP Users Search Scope
-
Search scope to find user entries.
The possible values for this property are:
-
SCOPE_BASE -
SCOPE_ONE -
SCOPE_SUB
Default value:
SCOPE_SUBamsterattribute:usersSearchScope -
- LDAP Users Search Attribute
-
Naming attribute for user entries.
Default value:
uidamsterattribute:usersSearchAttribute - Maximum Results Returned from Search
-
Search limit for LDAP searches.
Default value:
100amsterattribute:maximumSearchResults - Search Timeout
-
Time after which AM returns an error for an incomplete search, in seconds.
Default value:
5amsterattribute:searchTimeout - LDAP SSL/TLS
-
If enabled, AM connects securely to the directory server. This requires that you install the directory server certificate.
Default value:
trueamsterattribute:sslEnabled - LDAP Connection Pool Minimum Size
-
Minimum number of connections in the pool.
Default value:
1amsterattribute:connectionPoolMinimumSize - LDAP Connection Pool Maximum Size
-
Maximum number of connections in the pool.
Default value:
10amsterattribute:connectionPoolMaximumSize - Heartbeat Interval
-
Specifies how often should AM send a heartbeat request to the directory.
Use this option in case a firewall/loadbalancer can close idle connections, since the heartbeat requests will ensure that the connections won’t become idle.
Default value:
10amsterattribute:policyHeartbeatInterval - Heartbeat Unit
-
Defines the time unit corresponding to the Heartbeat Interval setting.
Use this option in case a firewall/loadbalancer can close idle connections, since the heartbeat requests will ensure that the connections won’t become idle.
The possible values for this property are:
-
Label: second (Value:
SECONDS) -
Label: minute (Value:
MINUTES) -
Label: hour (Value:
HOURS)
Default value:
SECONDSamsterattribute:policyHeartbeatTimeUnit -
- Subjects Result Time to Live
-
Maximum time that AM caches a subject result for evaluating policy requests, in minutes. A value of
0prevents AM from caching subject evaluations for policy decisions.Default value:
10amsterattribute:subjectsResultTTL - User Alias
-
If enabled, AM can evaluate policy for remote users aliased to local users.
Default value:
falseamsterattribute:userAliasEnabled - Check resources exist when Resource Server is updated
-
Check all registered resources exist when updating Resource Server.
Policy Set will check each registered Resource Types one by one against config datastore if enabled. Consider disabling this option if you have large number of Resource Types registered to a Policy Set.
Default value:
trueamsterattribute:checkIfResourceTypeExists
Push Notification service
amster service name: PushNotification
Realm defaults
The following settings appear on the Realm Defaults tab:
- SNS Access Key ID
-
Amazon Simple Notification Service Access Key ID. For more information, see Create an AWS (Push Auth) Credential in the ForgeRock Knowledge Base.
For example, you might set this property to: AKIAIOSFODNN7EXAMPLE
amsterattribute:accessKey - SNS Access Key Secret
-
Amazon Simple Notification Service Access Key Secret. For more information, see Create an AWS (Push Auth) Credential in the ForgeRock Knowledge Base.
amsterattribute:secret - SNS Endpoint for APNS
-
The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages to the Apple Push Notification Service (APNS).
For example, you might set this property to: arn:aws:sns:us-east-1:1234567890:app/APNS/production
amsterattribute:appleEndpoint - SNS Endpoint for GCM
-
The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages over Google Cloud Messaging (GCM).
For example, you might set this property to: arn:aws:sns:us-east-1:1234567890:app/GCM/production
amsterattribute:googleEndpoint - SNS Client Region
-
Region of your registered Amazon Simple Notification Service client. For more information, see https://docs.aws.amazon.com/general/latest/gr/rande.html.
The possible values for this property are:
-
us-gov-west-1 -
us-east-1 -
us-west-1 -
us-west-2 -
eu-west-1 -
eu-central-1 -
ap-southeast-1 -
ap-southeast-2 -
ap-northeast-1 -
ap-northeast-2 -
sa-east-1 -
n-north-1
Default value:
us-east-1amsterattribute:region -
- Message Transport Delegate Factory
-
The fully qualified class name of the factory responsible for creating the PushNotificationDelegate. The class must implement
org.forgerock.openam.services.push.PushNotificationDelegate.Default value:
org.forgerock.openam.services.push.sns.SnsHttpDelegateFactoryamsterattribute:delegateFactory - Response Cache Duration
-
The minimum lifetime to keep unanswered message records in the message dispatcher cache, in seconds. To keep unanswered message records indefinitely, set this property to
0.Should be tuned so that it is applicable to the use case of this service. For example, the ForgeRock Authenticator (Push) authentication module has a default timeout of 120 seconds.Default value:
120amsterattribute:mdDuration - Response Cache Concurrency
-
Level of concurrency to use when accessing the message dispatcher cache. Defaults to
16, and must be greater than0. Choose a value to accommodate as many threads as will ever concurrently access the message dispatcher cache.Default value:
16amsterattribute:mdConcurrency - Response Cache Size
-
Maximum size of the message dispatcher cache, in number of records. If set to
0the cache can grow indefinitely. If the number of records that need to be stored exceeds this maximum, then older items in the cache will be removed to make space.Default value:
10000amsterattribute:mdCacheSize
RADIUS server
amster service name: RadiusServer
Configuration
The following settings appear on the Configuration tab:
- Enabled
-
Lets the AM RADIUS server listen for requests on the listener port, and handle the requests.
The possible values for this property are:
-
NO -
YES
Default value:
NOamsterattribute:radiusListenerEnabled -
- Listener Port
-
The UDP port on which each AM server will listen for RADIUS Access-Request packets
According to the RADIUS Authentication Specification, RFC 2865, the officially assigned port number for RADIUS is
1812. Specify a value from1024to65535. All client requests are handled through the same port.Default value:
1812amsterattribute:radiusServerPort - Thread Pool Core Size
-
When a RADIUS request is received and fewer than
corePoolSizethreads are running, a new thread is created to handle the request, even if other worker threads are idle. If there are more than "Thread Pool Core Size" but less than "Thread Pool Max Size" threads running, a new thread will be created only if the queue is full. By setting "Thread Pool Core Size" and "Thread Pool Max Size" to the same value, you create a fixed-size thread pool. Specify a value from1to100.Default value:
1amsterattribute:radiusThreadPoolCoreSize - Thread Pool Max Size
-
Maximum number of threads allowed in the pool. See also "Thread Pool Core Size".
Default value:
10amsterattribute:radiusThreadPoolMaxSize - Thread Pool Keep-Alive Seconds
-
If the pool currently has more than Thread Pool Core Size threads, excess threads will be terminated if they have been idle for more than the Keep-Alive Seconds. Specify a value from
1to3600.Default value:
10amsterattribute:radiusThreadPoolKeepaliveSeconds - Thread Pool Queue Size
-
The number of requests that can be queued for the pool before further requests will be silently dropped. See also "Thread Pool Core Size" and "Thread Pool Max Size". Specify a value from
1to1000.Default value:
20amsterattribute:radiusThreadPoolQueueSize
Secondary configurations
This service has the following secondary configurations.
radiusClient
- Client IP Address
-
The IP Address of the client.
Section 5.4 of the RADIUS Authentication Specification, RFC 2865, indicates that the source IP address of the Access-Request packet MUST be used to identify a configured client and hence determine the shared secret to use for decrypting the User-Password field.
This property should hold the source IP address of the client. This should match the value obtained from Java’s
InetSocketAddress.getAddress().toString()function.To verify the value, send an Access-Request packet to AM’s RADIUS port and watch for a message stating:
"No Defined RADIUS Client matches IP address '/127.0.0.1'. Dropping request.". The value used in this property should match the IP address returned in the single quotes.Default value:
/127.0.0.1amsterattribute:clientIpAddress - Client Secret
-
This secret shared between server and client for encryption of the user password.
This secret must be conveyed to the RADIUS client and entered into its configuration before the User-Password field of incoming Access-Request packets can be decrypted to validate the password for the represented by that packet.
amsterattribute:clientSecret - Log Packet Contents for this Client
-
Indicates if full packet contents should be dumped to the log.
When troubleshooting issues with RADIUS it is helpful to know what was received in a given packet. Enabling this feature will cause packet contents to be logged in a human consumable format. The only caveat is that the USER_PASSWORD field will be obfiscated by replacing with asterisks. This should only be enabled for troubleshooting as it adds significant content to logs and slows processing.
Default value:
NOamsterattribute:clientPacketsLogged - Handler Class
-
The fully qualified name of a class to handle incoming RADIUS Access-Requests for this client.
This class must implement the
com.sun.identity.authentication.modules.radius.server.spi.AccessRequestHandlerinterface to handle incoming Access-Request packets and provide a suitable response. An instance of this class is created when configuration is first loaded to validate the class and then once for each new request. The configuration properties will only be passed for the request handling instances and not when validating the class.Default value:
org.forgerock.openam.radius.server.spi.handlers.OpenAMAuthHandleramsterattribute:handlerClass - Handler Class Configuration Properties
-
Properties needed by the handler class for its configuration.
These properties are provided to the handler via its
initmethod prior to the call to handle the request packet. If these values are changed the next handler instance created for an incoming request will receive the updated values. Each entry assumes that the first ‘`=`’ character incurred separates a key from its value. All entries are placed in a properties file handed to each handler instance.Default value:
realm=/ chain=ldapService
amsterattribute:handlerConfig
REST APIs
amster service name: RestApis
The following settings are available in this service:
- Default Resource Version
-
The API resource version to use when the REST request does not specify an explicit version.
The possible values for this property are:
-
Latest. If an explicit version is not specified, the latest resource version of an API is used. -
Oldest. If an explicit version is not specified, the oldest supported resource version of an API is used. Note that since APIs may be deprecated and fall out of support, the oldest supported version may not be the first version. -
None. If an explicit version is not specified, the request will not be handled and an error status is returned.
Default value:
Latestamsterattribute:defaultVersion -
- Warning Header
-
Whether to include a warning header in the response to a request which fails to include the
Accept-API-Versionheader.Default value:
trueamsterattribute:warningHeader - API Descriptions
-
Whether API Explorer and API Docs are enabled in AM and how the documentation for them is generated. Dynamic generation includes descriptions from any custom services and authentication modules you may have added. Static generation only includes services and authentication modules that were present when AM was built. Note that dynamic documentation generation may not work in some application containers.
The possible values for this property are:
-
Label: Enabled with Dynamic Documentation (Value:
DYNAMIC) -
Label: Enabled with Static Documentation (Value:
STATIC) -
DISABLED
Default value:
STATICamsterattribute:descriptionsState -
- Default Protocol Version
-
The API protocol version to use when a REST request does not specify an explicit version. Choose from:
The possible values for this property are:
-
Oldest. If an explicit version is not specified, the oldest protocol version is used. -
Latest. If an explicit version is not specified, the latest protocol version is used. -
None. If an explicit version is not specified, the request will not be handled and an error status is returned.
Default value:
Latestamsterattribute:defaultProtocolVersion -
- Enable CSRF Protection
-
If enabled, all non-read/query requests will require the X-Requested-With header to be present.
Requiring a non-standard header ensures requests can only be made via methods (XHR) that have stricter same-origin policy protections in Web browsers, preventing Cross-Site Request Forgery (CSRF) attacks. Without this filter, cross-origin requests are prevented by the use of the application/json Content-Type header, which is less robust.
Default value:
trueamsterattribute:csrfFilterEnabled
Remote Consent service
amster service name: RemoteConsentService
Realm defaults
The following settings appear on the Realm Defaults tab:
- Client Name
-
The name used to identify this OAuth 2.0 remote consent service when referencedin other services.
amsterattribute:clientId - Authorization Server jwk_uri
-
The jwk_uri for retrieving the authorization server signing and encryption keys.
amsterattribute:jwksUriAS - JWK Store Cache Timeout (in minutes)
-
The cache timeout for the JWK store of the authorization server, in minutes.
Default value:
60amsterattribute:jwkStoreCacheTimeout - JWK Store Cache Miss Cache Time (in minutes)
-
The length of time a cache miss is cached, in minutes.
Default value:
1amsterattribute:jwkStoreCacheMissCacheTime - Consent Response Time Limit (in minutes)
-
The time limit set on the consent response JWT before it expires, in minutes.
Default value:
2amsterattribute:consentResponseTimeLimit
SAML v2.0 SOAP binding
amster service name: SamlV2SoapBinding
The following settings are available in this service:
- Request Handler List
-
List of handlers to deal with SAML v2.0 requests bound to SOAP.
The required format is:
key=Meta Alias|class=Handler ClassSet the key property for a request handler to the meta alias, and the class property to the name of the class that implements the handler.
For example:
key=/pdp|class=com.sun.identity.xacml.plugins.XACMLAuthzDecisionQueryHandleramsterattribute:requestHandlers
SAML v2.0 service configuration
amster service name: SamlV2ServiceConfiguration
The following settings are available in this service:
- Cache cleanup interval (in seconds)
-
Time between cache cleanup operations, in seconds.
Default value:
600amsterattribute:cacheCleanupInterval - Attribute name for Name ID information
-
User entry attribute to store name identifier information.
Default value:
sun-fm-saml2-nameid-infoamsterattribute:nameIDInfoAttribute - Attribute name for Name ID information key
-
User entry attribute to store the name identifier key.
Default value:
sun-fm-saml2-nameid-infokeyamsterattribute:nameIDInfoKeyAttribute - Cookie domain for IdP Discovery Service
-
Specifies the cookie domain for the IDP discovery service.
Default value:
openam.example.comamsterattribute:idpDiscoveryCookieDomain - Cookie type for IdP Discovery Service
-
Specifies the cookie type to use.
The possible values for this property are:
-
PERSISTENT -
SESSION
Default value:
PERSISTENTamsterattribute:idpDiscoveryCookieType -
- URL scheme for IdP Discovery Service
-
Specifies the URL scheme to use.
The possible values for this property are:
-
HTTP -
HTTPS
Default value:
HTTPSamsterattribute:idpDiscoveryUrlSchema -
- XML Encryption SPI implementation class
-
Used by the SAML2 engine to encrypt and decrypt documents.
Default value:
com.sun.identity.saml2.xmlenc.FMEncProvideramsterattribute:xmlEncryptionClass - Include xenc:EncryptedKey inside ds:KeyInfo Element
-
Specify whether to include the
xenc:EncryptedKeyproperty inside theds:KeyInfoelement.Default value:
trueamsterattribute:encryptedKeyInKeyInfo - XML Signing SPI implementation class
-
Used by the SAML2 engine to sign documents.
Default value:
com.sun.identity.saml2.xmlsig.FMSigProvideramsterattribute:xmlSigningClass - XML Signing Certificate Validation
-
If enabled, then validate certificates used to sign documents.
Default value:
falseamsterattribute:signingCertValidation - CA Certificate Validation
-
If enabled, then validate CA certificates.
Default value:
falseamsterattribute:caCertValidation - Buffer length (in bytes) to decompress request
-
Specify the size of the buffer used for decompressing requests, in bytes.
Default value:
2048amsterattribute:bufferLength
Scripting
amster service name: Scripting
Configuration
The following settings appear on the Configuration tab:
- Default Script Type
-
The default script context type when creating a new script.
The possible values for this property are:
-
Label: Policy Condition (Value:
POLICY_CONDITION) -
Label: Server-side Authentication (Value:
AUTHENTICATION_SERVER_SIDE) -
Label: Client-side Authentication (Value:
AUTHENTICATION_CLIENT_SIDE) -
Label: OIDC Claims (Value:
OIDC_CLAIMS) -
Label: Decision node script for authentication trees (Value:
AUTHENTICATION_TREE_DECISION_NODE) -
Label: OAuth2 Access Token Modification (Value:
OAUTH2_ACCESS_TOKEN_MODIFICATION) -
Label: Social Identity Provider Profile Transformation (Value:
SOCIAL_IDP_PROFILE_TRANSFORMATION) -
Label: OAuth2 May Act (Value:
OAUTH2_MAY_ACT)
Default value:
POLICY_CONDITIONamsterattribute:defaultContext -
Secondary configurations
This service has the following secondary configurations.
Engine configuration
The following properties are available for Scripting Service secondary configuration instances:
- Engine Configuration
-
Configure script engine parameters for running a particular script type in AM.
ssoadmattribute:engineConfigurationTo access a secondary configuration instance using the
ssoadmcommand, use:--subconfigname [primary configuration]/[secondary configuration]. For example:$ ssoadm set-sub-cfg \ --adminid uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org \ --password-file admin_pwd_file \ --servicename ScriptingService \ --subconfigname OIDC_CLAIMS/engineConfiguration \ --operation set \ --attributevalues maxThreads=300 queueSize=-1Supports server-side scripts only. AM cannot configure engine settings for client-side scripts.
The configurable engine settings are as follows:
- Server-side Script Timeout
-
The maximum execution time any individual script should take on the server (in seconds). AM terminates scripts which take longer to run than this value.
ssoadmattribute:serverTimeout - Core thread pool size
-
The initial number of threads in the thread pool from which scripts operate. AM will ensure the pool contains at least this many threads.
ssoadmattribute:coreThreads - Maximum thread pool size
-
The maximum number of threads in the thread pool from which scripts operate. If no free thread is available in the pool, AM creates new threads in the pool for script execution up to the configured maximum. It is recommended to set the maximum number of threads to 300.
ssoadmattribute:maxThreads - Thread pool queue size
-
Specifies the number of threads to use for buffering script execution requests when the maximum thread pool size is reached.
For short, CPU-bound scripts, consider a small pool size and larger queue length. For I/O-bound scripts, for example, REST calls, consider a larger maximum pool size and a smaller queue.
Not hot-swappable: restart server for changes to take effect.
ssoadmattribute:queueSize - Thread idle timeout (seconds)
-
Length of time (in seconds) for a thread to be idle before AM terminates created threads. If the current pool size contains the number of threads set in
Core thread pool sizeidle threads will not be terminated, to maintain the initial pool size.ssoadmattribute:idleTimeout - Java class allowlist
-
Specifies the list of class-name patterns allowed to be invoked by the script. Every class accessed by the script must match at least one of these patterns.
You can specify the class name as-is or use a regular expression.
ssoadmattribute:whiteList - Java class denylist
-
Specifies the list of class-name patterns that are NOT allowed to be invoked by the script. The denylist is applied AFTER the allowlist to exclude those classes. Access to a class specified in both the allowlist and the denylist will be denied.
You can specify the class name to exclude as-is or use a regular expression.
ssoadmattribute:blackList - Use system SecurityManager
-
If enabled, AM will make a call to
System.getSecurityManager().checkPackageAccess(…)for each class that is accessed. The method throwsSecurityExceptionif the calling thread is not allowed to access the package.This feature only takes effect if the security manager is enabled for the JVM.
ssoadmattribute:useSecurityManager
- Scripting languages
-
Select the languages available for scripts on the chosen type. Either
GROOVYorJAVASCRIPT.ssoadmattribute:languages - Default Script
-
The source code that is presented as the default when creating a new script of this type.
ssoadmattribute:defaultScript
Session
amster service name: SessionUserService
General
The following settings appear on the General tab:
- Latest Access Time Update Frequency
-
Defaults to
60seconds. At most, AM updates a session’s latest access time this often.Subsequent touches to the session that occur within the specified number of seconds after an update will not cause additional updates to the session’s access time.
Refreshing a session returns the idle time as the number of seconds since an update has occurred, which will be between
0and the specified Latest Access Time Update Frequency.Default value:
60amsterattribute:latestAccessTimeUpdateFrequency - DN Restriction Only Enabled
-
If enabled, AM will not perform DNS lookups when checking restrictions in cookie hijacking mode.
Default value:
falseamsterattribute:dnRestrictionOnly - Session Timeout Handler implementations
-
Lists plugin classes implementing session timeout handlers. Specify the fully qualified name.
amsterattribute:timeoutHandlers
- Enable Cross Upgrade Session Reference
-
If enabled, the AM session will contain an additional session reference property, the value of which is persisted across session upgrade.
To access the cross-upgrade session reference—for example, from within a script or when getting session information—allowlist the property
XUSRefin the Session Property Whitelist service.The session reference can be tracked in the audit logs for session creation and session upgrade events.
amsterattribute:crossUpgradeReferenceFlag
Session search
The following settings appear on the Session Search tab:
- Maximum Number of Search Results
-
Maximum number of results from a session search. Do not set this attribute to a large value, for example more than 1000, unless sufficient system resources are allocated.
Default value:
120amsterattribute:maxSessionListSize - Timeout for Search
-
Time after which AM sees an incomplete search as having failed, in seconds.
Default value:
5amsterattribute:sessionListRetrievalTimeout
Session property change notifications
The following settings appear on the Session Property Change Notifications tab:
- Enable Property Change Notifications
-
If enabled, AM notifies other applications participating in SSO when a session property in the Notification Properties list changes on a server-side session.
The possible values for this property are:
-
ON -
OFF
Default value:
OFFamsterattribute:propertyChangeNotifications -
- Notification Properties
-
Lists session properties for which AM can send notifications upon modification. Session notification applies to server-side sessions only.
amsterattribute:notificationPropertyList
Session quotas
The following settings appear on the Session Quotas tab:
- Enable Quota Constraints
-
If enabled, AM lets you set quota constraints on server-side sessions.
The possible values for this property are:
-
ON -
OFF
Default value:
OFFamsterattribute:iplanet-am-session-enable-session-constraint -
- Read Timeout for Quota Constraint
-
Maximum wait time after which AM considers a search for live session count as having failed if quota constraints are enabled, in milliseconds.
Default value:
6000amsterattribute:quotaConstraintMaxWaitTime - Resulting behavior if session quota exhausted
-
Specify the action to take if a session quota is exhausted:
The possible values for this property are:
-
Deny Access (
org.forgerock.openam.session.service.DenyAccessAction). New session creation requests are denied. -
Destroy Next Expiring
org.forgerock.openam.session.service.DestroyNextExpiringAction). The session that would expire next is destroyed. -
Destroy Oldest (
org.forgerock.openam.session.service.DestroyOldestAction). The oldest session is destroyed. -
Destroy All (
org.forgerock.openam.session.service.DestroyAllAction). All previous sessions are destroyed.
Default value:
org.forgerock.openam.session.service.DestroyNextExpiringActionamsterattribute:behaviourWhenQuotaExhausted -
- Deny user login when session repository is down
-
This property only takes effect when the session quota constraint is enabled, and the session data store is unavailable.
The possible values for this property are:
-
YES -
NO
Default value:
NOamsterattribute:denyLoginWhenRepoDown -
Client-side sessions
The following settings appear on the Client-Side Sessions tab:
- Signing Algorithm Type
-
The algorithm that AM uses to sign the JSON Web Token (JWT) containing the session content. Signing the JWT enables tampering detection.
The possible values for this property are:
-
NONE -
HS256. HMAC using SHA-256. -
HS384. HMAC using SHA-384. -
HS512. HMAC using SHA-512. -
RS256. RSASSA-PKCS1-v1_5 using SHA-256. -
ES256. ECDSA using SHA-256 and NIST standard P-256 elliptic curve. -
ES384. ECDSA using SHA-384 and NIST standard P-384 elliptic curve. -
ES512. ECDSA using SHA-512 and NIST standard P-521 elliptic curve.
Default value:
HS256amsterattribute:statelessSigningType -
- Signing HMAC Shared Secret
-
Specifies the shared secret that AM uses when performing HMAC signing on the session JWT.
Specify a shared secret when using a "Signing Algorithm Type" of
HS256,HS384, orHS512.amsterattribute:statelessSigningHmacSecret - Encryption Algorithm
-
Specifies the algorithm that AM uses to encrypt the JSON Web Token (JWT) containing the session content.
The possible values for this property are:
-
NONE. Session content is not encrypted. -
RSA. Session content is encrypted with AES using a unique key. The key is then encrypted with an RSA public key and appended to the JWT.AM supports the following padding modes, which you can set using the
org.forgerock.openam.session.stateless.rsa.paddingadvanced property:-
RSA1_5. RSA with PKCS#1 v1.5 padding. -
RSA-OAEP. RSA with optimal asymmetric encryption padding (OAEP) and SHA-1. -
RSA-OAEP-256. RSA with OAEP padding and SHA-256.
-
-
AES_KEYWRAP. AES key wrapping.Session content is encrypted with AES using a unique key and is then wrapped using AES KeyWrap and the master key. This provides additional security, compared to RSA, at the cost of 128 or 256 bits (or 32 bytes) depending on the size of the master key. This method provides authenticated encryption, which removes the need for a separate signature and decreases the byte size of the JWT. See RFC 3394.
-
DIRECT. Direct AES encryption.Session content is encrypted with direct AES encryption, with a symmetric key. This method provides authenticated encryption, which removes the need for a separate signature and decreases the byte size of the JWT.
Users can accidentally disable all authentication by disabling signing and not using an authenticated encryption mode. To prevent this, set the org.forgerock.openam.session.stateless.signing.allownonesystem property totrueto turn off signing completely.Default value:
DIRECTamsterattribute:statelessEncryptionType -
- Encryption Symmetric AES Key
-
AES key for use with Direct or AES KeyWrap encryption modes.
The symmetric AES key is a base64-encoded random key.
For direct encryption with
AES-GCMor forAES-KeyWrapwith any content encryption method, this should be 128, 192, or 256 bits.For direct encryption with
AES-CBC-HMAC, the key should be double those sizes (one half for the AES key, the other have for the HMAC key).AES key sizes greater than 128 bits require installation of the JCE Unlimited Strength policy files in your JRE.
amsterattribute:statelessEncryptionAesKey - Compression Algorithm
-
If enabled the session state is compressed before signing and encryption.
Enabling compression can compromise encryption. This may leak information about the content of the session state if encryption is enabled. The possible values for this property are:
-
NONE -
DEF. Deflate Compression.
Default value:
NONEamsterattribute:statelessCompressionType -
- Enable Session Denylisting
-
Denylists client-side sessions that log out.
Enable this setting if the maximum session time is high. The denylist state is stored in the Core Token Service (CTS) token store until the session expires, to ensure that sessions cannot continue to be used.
Default value:
falseamsterattribute:openam-session-stateless-enable-session-blacklisting - Session Denylist Cache Size
-
Number of denylisted sessions to cache in memory to speed up denylist checks and reduce load on the CTS. The cache size should be approximately the number of logouts expected in the maximum session time.
Default value:
10000amsterattribute:openam-session-stateless-blacklist-cache-size - Denylist Poll Interval (seconds)
-
Specifies the interval at which AM polls the Core Token Service to update the list of logged out sessions, in seconds.
The longer the polling interval, the more time a malicious user has to connect to other AM servers in a deployment and make use of a stolen session cookie. Shortening the polling interval improves the security for logged out sessions, but might incur a minimal decrease in overall AM performance due to increased network activity. Set to
0to disable this feature completely.Default value:
60amsterattribute:openam-session-stateless-blacklist-poll-interval - Denylist Purge Delay (minutes)
-
When added to the maximum session time, specifies the amount of time that AM tracks logged out sessions.
Increase the denylist purge delay if you expect system clock skews in your deployment to be greater than one minute. You don’t need to increase the denylist purge delay for servers running a clock synchronization protocol, such as the Network Time Protocol.
Default value:
1amsterattribute:openam-session-stateless-blacklist-purge-delay
- Enable Invalidation of Sessions Based on User Identifier
-
Let AM permit logging out all client-side sessions for a specific user, through the
logoutByUseraction.Setting this to
truecauses AM to store logout user tokens in a local cache. For multi-server deployments, AM polls the CTS at a specified interval and populates the cache with the logout user tokens of all servers in the deployment.Default value:
falseamsterattribute:statelessLogoutByUser - Invalidated Sessions Poll Interval (seconds)
-
When Enable Invalidation of Sessions Based on User Identifier is
true, this setting specifies the frequency at which AM polls the CTS for changes to persisted logout tokens.Default value:
60amsterattribute:openam-session-stateless-logout-poll-interval
Dynamic attributes
|
Configuring any of the following properties at the realm level (Realms > Realm Name > Services > Session) causes the values to be stored in the identity store configured in that realm. If you remove the identity store from the realm, the properties will use the values configured at the global level (Configure > Global Services > Session). |
The following settings appear on the Dynamic Attributes tab:
- Maximum Session Time
-
Maximum time a session can remain valid before AM requires the user to authenticate again, in minutes.
Default value:
120amsterattribute:maxSessionTime - Maximum Idle Time
-
Maximum time a server-side session can remain idle before AM requires the user to authenticate again, in minutes.
Default value:
30amsterattribute:maxIdleTime - Maximum Caching Time
-
Maximum time that external clients of AM are recommended to cache the session for, in minutes.
Default value:
3amsterattribute:maxCachingTime - Active User Sessions
-
Maximum number of concurrent server-side sessions per user.
Default value:
5This value does not apply if Enable Quota ConstraintsisOFF. In other words, session quota constraints must be enabled for any configured maximum to apply.amsterattribute:quotaLimit
Session Property Whitelist service
amster service name: SessionPropertyWhiteList
Realm defaults
The following settings appear on the Realm Defaults tab:
- Allowlisted Session Property Names
-
A list of properties that users may read, edit the value of, or delete from their session.
Adding properties to sessions can impact AM’s performance. There is no limit on the set of properties that you can add to sessions, and no limit on the number of session properties you can add.
Adding session properties can increase the load on an AM deployment in the following areas:
-
AM server memory
-
LDAP server storage
-
LDAP server replication
Protected attributes can NOT be set, edited or deleted, even if they are included in this allowlist.
Default value:
AMCtxIdamsterattribute:sessionPropertyWhitelist -
- Session Properties to return for session queries
-
A list of session properties that can be returned to admins in a REST session query response.
This setting may impact REST query performance - when session properties are added, the CTS token must be retrieved, and will be the subject of decryption and decompression, if configured.
Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this list.
amsterattribute:whitelistedQueryProperties
Social authentication implementations
amster service name: SocialAuthentication
Realm defaults
The following settings appear on the Realm Defaults tab:
- Display Names
-
The display names for the implementations - this will be used to provide a name for the icon displayed on the login page. The key should be used across all the settings on this page to join them together.
For example:
Key
Value
google
Google
Default value:
{}amsterattribute:displayNames - Authentication Chains
-
The name of the authentication chains that are the entry points to being authenticated by each respective social authentication provider. The key should correspond to a key used to define a Display Name above.
For example:
Key
Value
google
socialAuthChainGoogle
Default value:
{}amsterattribute:authenticationChains - Icons
-
Either a full URL or a path relative to the base of the site/server where the image can be found. The image will be used on the login page to link to the authentication chain defined above. The key should correspond to a key used to define a Display Name above.
For example:
Key
Value
google
/images/google-sign-in.png
Default value:
{}amsterattribute:icons - Enabled Implementations
-
Provide a key that has been used to define the settings above to enable that set of settings.
For example: google
amsterattribute:enabledKeys
Social Identity Provider service
amster service name: SocialIdentityProviders
Transaction Authentication service
amster service name: TransactionAuthentication
UMA provider
amster service name: UmaProvider
Global Attributes
The following settings appear on the Global Attributes tab:
- UMA Policy Upgrade Compatibility Mode
-
When this setting is enabled, AM creates backward-compatible UMA policies. Enable this setting when you are upgrading from servers prior to AM 7.2.0, and when you are upgrading multiple servers in a deployment at different times. Disable this setting when you have completed the upgrade for all AM instances in your deployment.
Default value:
falseamsterattribute:umaPolicyUpgradeCompatibilityMode
General
The following settings appear on the General tab:
- Permission Ticket Lifetime (seconds)
-
The maximum life of a permission ticket before it expires, in seconds.
Default value:
120amsterattribute:permissionTicketLifetime - Delete user policies when Resource Server is removed
-
Delete all user policies that relate to a Resource Server when removing the OAuth2 agent entry or removing the
uma_protectionscope from the OAuth2 agent.Default value:
trueamsterattribute:deletePoliciesOnDeleteRS - Delete resources when Resource Server is removed
-
Delete all resources that relate to a Resource Server when removing the OAuth2 agent entry or removing the
uma_protectionscope from the OAuth2 agent.Default value:
trueamsterattribute:deleteResourceSetsOnDeleteRS - Pending Requests Enabled
-
Use the Pending Requests subsystem to notify the resource owner that an attempt was made to access their resource.
Default value:
trueamsterattribute:pendingRequestsEnabled - Email Resource Owner on Pending Request creation
-
Send an email to the Resource Owner when a Pending Request is created, when a Requesting Party requests access to a resource.
Default value:
trueamsterattribute:emailResourceOwnerOnPendingRequestCreation - Email Requesting Party on Pending Request approval
-
Send an email to the Requesting Party when a Pending Request is approved by the Resource Owner.
Default value:
trueamsterattribute:emailRequestingPartyOnPendingRequestApproval - Grant Resource Owner Implicit Consent
-
Implicitly grant the resource owner consent to the resource, regardless of policy conditions.
Default value:
trueamsterattribute:resourceOwnerImplicitConsent - User profile preferred Locale attribute
-
User profile attribute storing the user’s preferred locale.
Default value:
inetOrgPersonamsterattribute:userProfileLocaleAttribute - Re-Sharing Mode
-
Specifies whether re-sharing is off or on implicitly for all users, allowing all users to re-share resources that have been shared with them.
The possible values for this property are:
-
Off -
Implicit
Default value:
Implicitamsterattribute:resharingMode -
- Grant RPTs…
-
In UMA, scope comes from both the permission ticket and from the token request. An RPT is always granted when all scopes match, and is never granted when no scope matches. You can configure when RPTs are granted for partial match conditions here. For more information, see Assessment and Results Determination in the UMA 2.0 Grant Specification.
Default value:
When the scope from the request is partially matched. When none of the scope from the request is matched. When the scope from the ticket is partially matched.amsterattribute:grantRptConditions - Username attribute
-
The name of the attribute whose value must be specified by end users when sharing resources. For example, if a user wants to share a resource with another user, based on that user’s email address, set this value to
mail.The attribute that you set here must contain unique values; otherwise, a resource share can grant access to multiple users unintentionally.
If you leave this attribute empty, UMA policies are based on the attribute that the underlying data store considers the
username(for example, the LDAP user search attribute). This behavior is compatible with previous AM versions. The UMA Postman Collection sets this value touid, which works in most deployments.Changing this setting can invalidate existing UMA authorizations.
Default value: None
amsterattribute:usernameAttribute
Claims gathering
The following properties can be set on the Claims Gathering tab:
- Interactive Claims Gathering Enabled
-
If this setting is enabled, and no PCT is provided on the request, the UMA provider returns a redirect_user hint to the client, where the requesting party can authenticate themselves.
Default value:
falseamsterattribute:interactiveClaimsGatheringEnabled - Claims Gathering Authentication Tree
-
The authentication tree to which the requesting party should be directed, in order to collect claims. This authentication tree should collect all claims necessary for successful UMA authorization.
Default value: None
amsterattribute:claimsGatheringTree - Persisted Claims Token Lifetime (seconds)
-
During interactive claims gathering, AM can issue a PCT, that clients can use later during RPT flows, so that users don’t have to go through the interactive claims gathering process too frequently.
If a PCT is issued, this setting determines the interval (in seconds) that the PCT should be considered valid.
Default value:
604800(7 days)amsterattribute:pctLifetime
User
amster service name: IdRepositoryUser
Dynamic attributes
The following settings appear on the Dynamic Attributes tab:
- User Preferred Timezone
-
Time zone for accessing AM admin UI.
amsterattribute:preferredTimezone - Administrator DN Starting View
-
Specifies the DN for the initial screen when the AM administrator successfully logs in to the AM admin UI.
amsterattribute:adminDNStartingView - Default User Status
-
Inactive users cannot authenticate, although AM stores their profiles.
The possible values for this property are:
-
Active -
Inactive
Default value:
Activeamsterattribute:defaultUserStatus -
User Self-Service
amster service name: UserSelfService
General configuration
The following settings appear on the General Configuration tab:
- Encryption Key Pair Alias
-
An encryption key alias in the AM server’s JCEKS keystore. Used to encrypt the JWT token that AM uses to track end users during User Self-Service operations.
For example, you might set this property to: selfserviceenctest
amsterattribute:encryptionKeyPairAlias - Signing Secret Key Alias
-
A signing secret key alias in the AM server’s JCEKS keystore. Used to sign the JWT token that AM uses to track end users during User Self-Service operations.
For example, you might set this property to: selfservicesigntest
amsterattribute:signingSecretKeyAlias - Google reCAPTCHA Site Key
-
Google reCAPTCHA plugin site key.
amsterattribute:captchaSiteKey - Google reCAPTCHA Secret Key
-
Google reCAPTCHA plugin secret key.
amsterattribute:captchaSecretKey - Google Re-captcha Verification URL
-
Google reCAPTCHA plugin verification URL.
Default value:
https://www.google.com/recaptcha/api/siteverifyamsterattribute:captchaVerificationUrl - Security Questions
-
Specifies the default set of knowledge-based authentication (KBA) security questions. The security questions can be set for the User Self-Registration, forgotten password reset, and forgotten username services, respectively.
Format is
unique key|locale|question.Default value:
4|en|What is your mother's maiden name? 3|en|What was the name of your childhood pet? 2|en|What was the model of your first car? 1|en|What is the name of your favourite restaurant?
amsterattribute:kbaQuestions - Minimum Answers to Define
-
Specifies the minimum number of KBA answers that users must define.
Default value:
1amsterattribute:minimumAnswersToDefine - Minimum Answers to Verify
-
Specifies the minimum number of KBA questions that users need to answer to be granted the privilege to carry out an action, such as registering for an account, resetting a password, or retrieving a username. Specify a value from
0to50.Default value:
1amsterattribute:minimumAnswersToVerify - Valid Query Attributes
-
Specifies the valid query attributes used to search for the user. This is a list of attributes used to identify your account for forgotten password and forgotten username.
Default value:
uid mail givenName sn
amsterattribute:validQueryAttributes
User registration
The following settings appear on the User Registration tab:
- User Registration
-
If enabled, new users can sign up for an account.
Default value:
falseamsterattribute:userRegistrationEnabled - Captcha
-
If enabled, users must pass a Google reCAPTCHA challenge during user self-registration to mitigate against software bots.
Default value:
falseamsterattribute:userRegistrationCaptchaEnabled - Email Verification
-
If enabled, users who self-register must perform email address verification.
Default value:
trueamsterattribute:userRegistrationEmailVerificationEnabled - Verify Email before User Detail
-
If enabled, email address verification will be performed first before user details screen is displayed. This will take effect only if Verify Email is enabled.
Default value:
falseamsterattribute:userRegistrationEmailVerificationFirstEnabled - Security Questions
-
If enabled, users must set up their security questions during the self-registration process.
Default value:
falseamsterattribute:userRegistrationKbaEnabled - Token Lifetime (seconds)
-
Maximum lifetime of the token allowing User Self-Registration, in seconds.
Default value:
300amsterattribute:userRegistrationTokenTTL - Outgoing Email Subject
-
Customize the User Self-Registration verification email subject text. Format is
locale|subject text.Default value:
en|Registration emailamsterattribute:userRegistrationEmailSubject - Outgoing Email Body
-
Customize the User Self-Registration verification email body text. Format is:
locale|body text.Default value:
en|<h2>Click on this <a href="%link%">link</a> to register.</h2>amsterattribute:userRegistrationEmailBody - Valid Creation Attributes
-
Specifies an allowlist of user attributes that can be set during user creation.
Default value:
userPassword mail givenName kbaInfo inetUserStatus sn username
amsterattribute:userRegistrationValidUserAttributes - Destination After Successful Self-Registration
-
The action to be taken after a user successfully registers a new account.
The possible values for this property are:
-
Label: User sent to 'successful registration' page (value:
default). User is sent to a success page, without being logged in. -
Label: User sent to login page (value:
login). User is sent to the login page to authenticate. -
Label: User is automatically logged in (value:
auto-login). User is automatically logged in and sent to the appropriate page.
Default value:
defaultamsterattribute:userRegisteredDestination -
Forgotten password
The following settings appear on the Forgotten Password tab:
- Forgotten Password
-
If enabled, users can reset their forgotten password.
Default value:
falseamsterattribute:forgottenPasswordEnabled - Captcha
-
If enabled, users must pass a Google reCAPTCHA challenge during password reset to mitigate against software bots.
Default value:
falseamsterattribute:forgottenPasswordCaptchaEnabled - Email Verification
-
If enabled, users who reset passwords must perform email address verification.
Default value:
trueamsterattribute:forgottenPasswordEmailVerificationEnabled - Security Questions
-
If enabled, users must answer their security questions during the forgotten password process.
Default value:
falseamsterattribute:forgottenPasswordKbaEnabled - Enforce password reset lockout
-
If enabled, users will be prevented from resetting their password after the configured number of failed attempts.
Default value:
falseamsterattribute:numberOfAttemptsEnforced - Lock Out After number of attempts
-
Can be set to 1 or more attempts for a user to correctly answer all their security questions. After the number of configured attempts the user has not correctly answered them the password reset feature will be disabled.
Default value:
1amsterattribute:numberOfAllowedAttempts - Token Lifetime (seconds)
-
Maximum lifetime for the token allowing forgotten password reset, in seconds.
Specify a value from
0to2147483647.Default value:
300amsterattribute:forgottenPasswordTokenTTL - Outgoing Email Subject
-
Customize the forgotten password email subject text. Format is
locale|subject text.Default value:
en|Forgotten password emailamsterattribute:forgottenPasswordEmailSubject - Outgoing Email Body
-
Customize the forgotten password email body text. Format is
locale|body text.Default value:
en|<h2>Click on this <a href="%link%">link</a> to reset your password.</h2>amsterattribute:forgottenPasswordEmailBody
Forgotten username
The following settings appear on the Forgotten Username tab:
- Forgotten Username
-
If enabled, users can retrieve their forgotten username.
Default value:
falseamsterattribute:forgottenUsernameEnabled - Captcha
-
If enabled, users must pass a Google reCAPTCHA challenge during the forgotten username retrieval process to mitigate against software bots.
Default value:
falseamsterattribute:forgottenUsernameCaptchaEnabled - Security Questions
-
If enabled, users must answer their security questions during the forgotten username process.
Default value:
falseamsterattribute:forgottenUsernameKbaEnabled - Email Username
-
If enabled, users receive their forgotten username by email.
Default value:
trueamsterattribute:forgottenUsernameEmailUsernameEnabled - Show Username
-
If enabled, users see their forgotten username on the browser page.
Default value:
falseamsterattribute:forgottenUsernameShowUsernameEnabled - Token LifeTime (seconds)
-
Maximum lifetime for the token allowing forgotten username, in seconds.
Default value:
300amsterattribute:forgottenUsernameTokenTTL - Outgoing Email Subject
-
Customizes the forgotten username email subject text. Format is
locale|subject text.Default value:
en|Forgotten username emailamsterattribute:forgottenUsernameEmailSubject - Outgoing Email Body
-
Customizes the forgotten username email body text. Format is
locale|body text.Default value:
en|<h2>Your username is <span style="color:blue">%username%</span>.</h2>amsterattribute:forgottenUsernameEmailBody
Profile management
The following settings appear on the Profile Management tab:
- Protected Update Attributes
-
Specifies a profile’s protected user attributes, which causes re-authentication when the user attempts to modify these attributes.
amsterattribute:profileProtectedUserAttributes - Self readable attributes
-
Specifies the list of attributes that users can view when accessing their user profile.
Default value:
uid telephoneNumber mail kbaInfo givenName sn cn
amsterattribute:profileAttributeWhitelist
Advanced configuration
The following settings appear on the Advanced Configuration tab:
- User Registration Confirmation Email URL
-
Specifies the confirmation URL that the user receives during the self-registration process. The
${realm}string is replaced with the current realm.Default value:
http://openam.example.com:8080/openam/XUI/?realm=${realm}#register/amsterattribute:userRegistrationConfirmationUrl - Forgotten Password Confirmation Email URL
-
Specifies the confirmation URL that the user receives after confirming their identity during the forgotten password process. The
${realm}string is replaced with the current realm.Default value:
http://openam.example.com:8080/openam/XUI/?realm=${realm}#passwordReset/amsterattribute:forgottenPasswordConfirmationUrl - User Registration Service Config Provider Class
-
Specifies the provider class to configure any custom plugins.
Default value:
org.forgerock.openam.selfservice.config.flows.UserRegistrationConfigProvideramsterattribute:userRegistrationServiceConfigClass - Forgotten Password Service Config Provider Class
-
Specifies the provider class to configure any custom plugins.
Default value:
org.forgerock.openam.selfservice.config.flows.ForgottenPasswordConfigProvideramsterattribute:forgottenPasswordServiceConfigClass - Forgotten Username Service Config Provider Class
-
Specifies the provider class to configure any custom plugins.
Default value:
org.forgerock.openam.selfservice.config.flows.ForgottenUsernameConfigProvideramsterattribute:forgottenUsernameServiceConfigClass
Self-Service trees
amster service name: SelfServiceTrees
Validation service
amster service name: ValidationService
Global attributes
The following settings appear on the Global Attributes tab:
- Valid goto URL Resources
-
List of valid goto URL resources.
Specifies a list of valid URLs for the
gotoandgotoOnFailquery string parameters. AM only redirects a user after log in or log out to a URL in this list. If the URL is not in the list, AM redirects to either the user profile page, or the administration console. If this property is not set, AM will only allow URLs that match its domain; for example,domain-of-am-instance.com. Use the*wildcard to match all characters except?.Examples:
amsterattribute:validGotoDestinations
Realm defaults
The following settings appear on the Realm Defaults tab:
- Valid goto URL Resources
-
List of valid goto URL resources.
Specifies a list of valid URLs for the
gotoandgotoOnFailquery string parameters. AM only redirects a user after log in or log out to a URL in this list. If the URL is not in the list, AM redirects to either the user profile page, or the administration console. If this property is not set, AM will only allow URLs that match its domain; for example,domain-of-am-instance.com. Use the*wildcard to match all characters except?.Examples:
amsterattribute:validGotoDestinations
WebAuthn Profile Encryption service
amster service name: AuthenticatorWebAuthn
Realm defaults
The following settings appear on the Realm Defaults tab:
- Profile Storage Attribute
-
The user’s attribute in which to store WebAuthn profiles.
The default attribute is added to the schema when you prepare a user store for use with AM. If you want to use a different attribute, you must make sure to add it to your user store schema prior to deploying webauthn with AM. AM must be able to write to the attribute.
Default value:
webauthnDeviceProfilesamsterattribute:webauthnAttrName - Device Profile Encryption Scheme
-
Encryption scheme to use to secure device profiles stored on the server.
If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.
AES-256 may require installation of the JCE Unlimited Strength policy files. The possible values for this property are:
-
Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (value:
RSAES_AES256CBC_HS512) -
Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (value:
RSAES_AES128CBC_HS256) -
Label: No encryption of device settings (value:
NONE)
Default value:
NONEamsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionScheme -
- Encryption Key Store
-
Path to the key store from which to load encryption keys.
Default value:
/path/to/openam/security/keystores/keystore.jceksamsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionKeystore - Key Store Type
-
Type of key store to load.
PKCS#11 key stores require hardware support such as a security device or smart card and is not available by default in most JVM installations. See the JDK 8 PKCS#11 Reference Guide for more details.
The possible values for this property are:
-
Label: Java Key Store (JKS) (value:
JKS) -
Label: Java Cryptography Extension Key Store (JCEKS) (value:
JCEKS) -
Label: PKCS#11 Hardware Crypto Storage (value:
PKCS11) -
Label: PKCS#12 Key Store (value:
PKCS12)
Default value:
JCEKSamsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionKeystoreType -
- Key Store Password
-
Password to unlock the key store. This password is encrypted when it is saved in the AM configuration. You should modify the default value.
amsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionKeystorePassword - Key-Pair Alias
-
Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.
amsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionKeystoreKeyPairAlias - Private Key Password
-
Password to unlock the private key.
amsterattribute:authenticatorWebAuthnDeviceSettingsEncryptionKeystorePrivateKeyPassword