SecurityProperties
Global Operations
An object of property key-value pairs
Resource path:
/global-config/servers/{serverName}/properties/security
Resource version: 1.0
read
Usage
am> read SecurityProperties --global --serverName serverName
Parameters
- --serverName
-
An object of property key-value pairs
update
Usage
am> update SecurityProperties --global --serverName serverName --body body
Parameters
- --serverName
-
An object of property key-value pairs
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "amconfig.header.encryption" : { "title" : "Encryption", "type" : "object", "propertyOrder" : 0, "properties" : { "am.encryption.pwd" : { "title" : "Password Encryption Key", "type" : "object", "propertyOrder" : 0, "description" : "The encryption key value for decrypting passwords stored in the Service Management System configuration. (property name: am.encryption.pwd)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.iplanet.security.encryptor" : { "title" : "Encryption class", "type" : "object", "propertyOrder" : 1, "description" : "The default encryption class. (property name: com.iplanet.security.encryptor)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.iplanet.security.SecureRandomFactoryImpl" : { "title" : "Secure Random Factory Class", "type" : "object", "propertyOrder" : 2, "description" : "This property is used for specifying SecureRandomFactory class. Available values for this property are com.iplanet.am.util.JSSSecureRandomFactoryImpl that is using JSS and com.iplanet.am.util.SecureRandomFactoryImpl that is using pure Java only. (property name: com.iplanet.security.SecureRandomFactoryImpl)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.enabled" : { "title" : "Enable Encryption KeyStore", "type" : "object", "propertyOrder" : 3, "description" : "Enables or disables retrieving the Password Encryption Key from the key store defined in the following fields.", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.alias" : { "title" : "Encryption Key Alias", "type" : "object", "propertyOrder" : 4, "description" : "The alias of the current active Password Encryption Key in the key store.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.keystoreFile" : { "title" : "Encryption KeyStore File", "type" : "object", "propertyOrder" : 5, "description" : "The location of the key store containing the Password Encryption Key.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.keystoreType" : { "title" : "Encryption KeyStore Type", "type" : "object", "propertyOrder" : 6, "description" : "The type of the key store.", "properties" : { "value" : { "enum" : [ "JCEKS", "PKCS12" ], "options" : { "enum_titles" : [ "JCEKS", "PKCS12" ] }, "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.keystorePass" : { "title" : "Encryption KeyStore Password File", "type" : "object", "propertyOrder" : 7, "description" : "The location of the file containing the key store password, in plain text.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "am.encryption.secret.keyPass" : { "title" : "Encryption Key Password File", "type" : "object", "propertyOrder" : 8, "description" : "The location of the file containing the key store key password, in plain text.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.validation" : { "title" : "Validation", "type" : "object", "propertyOrder" : 1, "properties" : { "com.iplanet.services.comm.server.pllrequest.maxContentLength" : { "title" : "Platform Low Level Comm. Max. Content Length", "type" : "object", "propertyOrder" : 0, "description" : "Maximum content-length for an HttpRequest. (property name: com.iplanet.services.comm.server.pllrequest.maxContentLength)", "properties" : { "value" : { "type" : "integer", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.iplanet.am.clientIPCheckEnabled" : { "title" : "Client IP Address Check", "type" : "object", "propertyOrder" : 1, "description" : "Specifies whether or not the IP address of the client is checked in all single sign on token creations or validations. (property name: com.iplanet.am.clientIPCheckEnabled)", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.cookie" : { "title" : "Cookie", "type" : "object", "propertyOrder" : 2, "properties" : { "com.iplanet.am.cookie.name" : { "title" : "Cookie Name", "type" : "object", "propertyOrder" : 0, "description" : "The cookie name used by Authentication Service to set the valid session handler ID. This name is used to retrieve the valid session information. (property name: com.iplanet.am.cookie.name)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.iplanet.am.cookie.secure" : { "title" : "Secure Cookie", "type" : "object", "propertyOrder" : 1, "description" : "Specifies whether to set cookie in a secure mode in which the browser will only return the cookie when a secure protocol such as HTTP(s) is used. (property name: com.iplanet.am.cookie.secure)", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.iplanet.am.cookie.encode" : { "title" : "Encode Cookie Value", "type" : "object", "propertyOrder" : 2, "description" : "Specifies whether to URL encode the cookie value. (property name: com.iplanet.am.cookie.encode)", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.securitykey" : { "title" : "Key Store", "type" : "object", "propertyOrder" : 3, "properties" : { "com.sun.identity.saml.xmlsig.keystore" : { "title" : "Keystore File", "type" : "object", "propertyOrder" : 0, "description" : "Specifies the location of the keystore file. (property name: com.sun.identity.saml.xmlsig.keystore)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.saml.xmlsig.storetype" : { "title" : "Keystore Type", "type" : "object", "propertyOrder" : 1, "description" : "Specifies the keystore type. (property name: com.sun.identity.saml.xmlsig.storetype)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.saml.xmlsig.storepass" : { "title" : "Keystore Password File", "type" : "object", "propertyOrder" : 2, "description" : "Specifies the location of the file that contains the password used to access the keystore file. (property name: com.sun.identity.saml.xmlsig.storepass)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.saml.xmlsig.keypass" : { "title" : "Private Key Password File", "type" : "object", "propertyOrder" : 3, "description" : "Specifies the location of the file that contains the password used to protect the private key of a generated key pair. (property name: com.sun.identity.saml.xmlsig.keypass)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.saml.xmlsig.certalias" : { "title" : "Certificate Alias", "type" : "object", "propertyOrder" : 4, "description" : "(property name: com.sun.identity.saml.xmlsig.certalias)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.crlcache" : { "title" : "Certificate Revocation List Caching", "type" : "object", "propertyOrder" : 4, "properties" : { "com.sun.identity.crl.cache.directory.host" : { "title" : "LDAP server host name", "type" : "object", "propertyOrder" : 0, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.port" : { "title" : "LDAP server port number", "type" : "object", "propertyOrder" : 1, "description" : "", "properties" : { "value" : { "type" : "integer", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.ssl" : { "title" : "SSL/TLS Enabled", "type" : "object", "propertyOrder" : 2, "description" : "", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.mtlsenabled" : { "title" : "mTLS Enabled", "type" : "object", "propertyOrder" : 3, "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>SSL/TLS Enabled</code>. <li>Set a secure port in <code>Connection String(s)</code>.</li> <li>The values for <code>LDAP server bind username</code> and <code>LDAP server bind password</code> are ignored.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation.", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.user" : { "title" : "LDAP server bind user name", "type" : "object", "propertyOrder" : 4, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.password" : { "title" : "LDAP server bind password", "type" : "object", "propertyOrder" : 5, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false, "format" : "password" }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.searchlocs" : { "title" : "LDAP search base DN", "type" : "object", "propertyOrder" : 6, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.crl.cache.directory.searchattr" : { "title" : "Search Attributes", "type" : "object", "propertyOrder" : 7, "description" : "Any DN component of issuer's subjectDN can be used to retrieve CRL from local LDAP server. It is single value string, like, \"cn\". All Root CA need to use the same search attribute.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.ocsp.check" : { "title" : "Online Certificate Status Protocol Check", "type" : "object", "propertyOrder" : 5, "properties" : { "com.sun.identity.authentication.ocspCheck" : { "title" : "Check Enabled", "type" : "object", "propertyOrder" : 0, "description" : "", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.authentication.ocsp.responder.url" : { "title" : "Responder URL", "type" : "object", "propertyOrder" : 1, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "com.sun.identity.authentication.ocsp.responder.nickname" : { "title" : "Certificate Nickname", "type" : "object", "propertyOrder" : 2, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.header.deserialisationwhitelist" : { "title" : "Object Deserialisation Class Whitelist", "type" : "object", "propertyOrder" : 6, "properties" : { "openam.deserialisation.classes.whitelist" : { "title" : "Whitelist", "type" : "object", "propertyOrder" : 0, "description" : "The list of classes that are considered valid when OpenAM performs Object deserialisation operations. The defaults should work for most installations. (property name: openam.deserialisation.classes.whitelist)", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } } } }