Manage the Oracle Web Services Manager Domain Configuration

You can use the Configuration REST API method to view and set domain-level configuration properties for Oracle Web Services Manager, including authentication, message security, and policy access.

The cURL command examples use the URL structure:

http(s)://host:port/wsm-pmrest/v2/configuration

To manage the domain configuration properties using the Configuration REST API:

Specify the headers on the cURL command line:
```
-H Accept:application/json
```

View all domain-level configuration properties for the domain (base_domain) and platform ( WLS) name by running the following command:

curl -i -X GET -u username:password -H Content-type:application/json http://host:port/wsm-pmrest/v2/configuration?platform={PlatformName}&domain={DomainName}&&name={propName}&category={Category}

Example

curl -i -X GET -u Smith:Password -H Content-type:application/json http://myhost:7001/wsm-pmrest/v2/configuration?platform=WLS&domain=base_domain

See Get ConfigurationProperty(s).

The following shows an example of the request body.

[
  {
    "name": "allow.all.xpaths",
    "category": "Agent",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "use.unified.fault.code",
    "category": "Agent",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "client.clock.skew",
    "category": "Agent",
    "source": "default",
    "values": [
      "0"
    ]
  },
  {
    "name": "compliance.check",
    "category": "Agent",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "clock.skew",
    "category": "Agent",
    "source": "/WLS/base_domain",
    "values": [
      "360000"
    ]
  },
  {
    "name": "expire.time",
    "category": "Agent",
    "source": "default",
    "values": [
      "300000"
    ]
  },
  {
    "name": "nonce.ttl",
    "category": "Agent",
    "source": "default",
    "values": [
      "28800000"
    ]
  },
  {
    "name": "server.token.caching",
    "category": "Agent",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "signature.cache.enable",
    "category": "Agent",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "cache.refresh.initial",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "600000"
    ]
  },
  {
    "name": "cache.refresh.repeat",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "600000"
    ]
  },
  {
    "name": "failure.retry.count",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "2"
    ]
  },
  {
    "name": "cache.refresh.batch.size",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "10"
    ]
  },
  {
    "name": "failure.retry.delay",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "5000"
    ]
  },
  {
    "name": "missing.retry.delay",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "15000"
    ]
  },
  {
    "name": "usage.record.delay",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "30000"
    ]
  },
  {
    "name": "jndi.connection.timeout",
    "category": "BeanAccessor",
    "source": "default",
    "values": [
      "30000"
    ]
  },
  {
    "name": "connect.retry.delay",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "60000"
    ]
  },
  {
    "name": "keystore.csf.key",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "keystore-csf-key"
    ]
  },
  {
    "name": "keystore.path",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "kss://owsm/keystore"
    ]
  },
  {
    "name": "keystore.ssl.alias",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "mykey"
    ]
  },
  {
    "name": "keystore.type",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "KSS"
    ]
  },
  {
    "name": "pm.csf.key",
    "category": "ConfigManager",
    "source": "default"
  },
  {
    "name": "pm.user.tenant.name",
    "category": "ConfigManager",
    "source": "default"
  },
  {
    "name": "pm.url",
    "category": "ConfigManager",
    "source": "default"
  },
  {
    "name": "auto.refresh",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "enabled"
    ]
  },
  {
    "name": "refresh.repeat",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "600000"
    ]
  },
  {
    "name": "ssl.twoway",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "truststore.csf.key",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "keystore-csf-key"
    ]
  },
  {
    "name": "truststore.path",
    "category": "ConfigManager",
    "source": "default",
    "values": [
      "kss://owsm/keystore"
    ]
  },
  {
    "name": "custom",
    "category": "DigestLoginModule",
    "source": "default"
  },
  {
    "name": "ignore.hostname.verification",
    "category": "Identity",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "ignore.identity.wsdl",
    "category": "Identity",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "lifetime",
    "category": "IssuedToken",
    "source": "default",
    "values": [
      "28800000"
    ]
  },
  {
    "name": "class.name",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "com.sun.security.auth.module.Krb5LoginModule"
    ]
  },
  {
    "name": "custom",
    "category": "KerberosLoginModule",
    "source": "default"
  },
  {
    "name": "do.not.prompt",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "key.tab",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "./krb5.keytab"
    ]
  },
  {
    "name": "principal",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "HOST/localhost@EXAMPLE.COM"
    ]
  },
  {
    "name": "store.key",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "use.key.tab",
    "category": "KerberosLoginModule",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "keystore.csf.map",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "oracle.wsm.security"
    ]
  },
  {
    "name": "keystore.enc.csf.key",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "orakey"
    ]
  },
  {
    "name": "keystore.pass.csf.key",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "keystore-csf-key"
    ]
  },
  {
    "name": "keystore.sig.csf.key",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "orakey"
    ]
  },
  {
    "name": "keystore.type",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "KSS"
    ]
  },
  {
    "name": "location",
    "category": "KeystoreConfig",
    "source": "default",
    "values": [
      "kss://owsm/keystore"
    ]
  },
  {
    "name": "add.assertion.to.subject",
    "category": "SAML2LoginModule",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "allow.virtual.user",
    "category": "SAML2LoginModule",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "custom",
    "category": "SAML2LoginModule",
    "source": "default"
  },
  {
    "name": "dn.mapping.attribute",
    "category": "SAML2LoginModule",
    "source": "default",
    "values": [
      "CN"
    ]
  },
  {
    "name": "allow.virtual.user",
    "category": "SAMLLoginModule",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "add.assertion.to.subject",
    "category": "SAMLLoginModule",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "custom",
    "category": "SAMLLoginModule",
    "source": "default"
  },
  {
    "name": "dn.mapping.attribute",
    "category": "SAMLLoginModule",
    "source": "default",
    "values": [
      "CN"
    ]
  },
  {
    "name": "name",
    "category": "TokenIssuerTrust",
    "source": "default",
    "values": [
      "oracle-default"
    ]
  },
  {
    "name": "rm.encrypt.body",
    "category": "SecureConversation",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "token.lifetime",
    "category": "SecureConversation",
    "source": "default",
    "values": [
      "1800000"
    ]
  },
  {
    "name": "token.lifetime.reauth",
    "category": "SecureConversation",
    "source": "default",
    "values": [
      "28800000"
    ]
  },
  {
    "name": "client.cache.ttyl",
    "category": "STSConfig",
    "source": "default",
    "values": [
      "28800000"
    ]
  },
  {
    "name": "add.application.roles",
    "category": "SubjectProperties",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "add.authenticated.role",
    "category": "SubjectProperties",
    "source": "default",
    "values": [
      "true"
    ]
  },
  {
    "name": "remove.anonymous.role",
    "category": "SubjectProperties",
    "source": "default",
    "values": [
      "false"
    ]
  },
  {
    "name": "custom",
    "category": "UsernameAssertionLoginModule",
    "source": "default"
  },
  {
    "name": "custom",
    "category": "UsernameAuthLoginModule",
    "source": "default"
  },
  {
    "name": "custom",
    "category": "WSSDigestLoginModule",
    "source": "default"
  },
  {
    "name": "dn.mapping.attribute",
    "category": "X509LoginModule",
    "source": "default",
    "values": [
      "CN"
    ]
  },
  {
    "name": "custom",
    "category": "X509LoginModule",
    "source": "default"
  }
]

View the configuration properties based on the property category Agent in the domain by running the following command:

curl -i -X GET -u username:password -H Content-type:application/json http://host:port/wsm-pmrest/v2/configuration?platform={PlatformName}&domain={DomainName}&category={Category}

Example

curl -i -X POST -u Smith:Password -H Content-type:application/json http://myhost:7001/wsm-pmrest/v2/trust/myTrustDocument/configuration?platform=WLS&domain=base_domain&category=Agent

See Get ConfigurationProperty(s).

The following shows an example of the response body:

[
  {
    "name": "allow.all.xpaths",
    "category": "Agent",
    "values": [
      "false"
    ],
    "source": "default"
  },
  {
    "name": "use.unified.fault.code",
    "category": "Agent",
    "values": [
      "true"
    ],
    "source": "default"
  },
  {
    "name": "client.clock.skew",
    "category": "Agent",
    "values": [
      "600000"
    ],
    "source": "/WLS/owsm_server_domain"
  },
  {
    "name": "compliance.check",
    "category": "Agent",
    "values": [
      "true"
    ],
    "source": "default"
  },
  {
    "name": "clock.skew",
    "category": "Agent",
    "values": [
      "360000"
    ],
    "source": "default"
  },
  {
    "name": "expire.time",
    "category": "Agent",
    "values": [
      "300000"
    ],
    "source": "default"
  },
  {
    "name": "nonce.ttl",
    "category": "Agent",
    "values": [
      "28800000"
    ],
    "source": "default"
  },
  {
    "name": "server.token.caching",
    "category": "Agent",
    "values": [
      "true"
    ],
    "source": "default"
  },
  {
    "name": "signature.cache.enable",
    "category": "Agent",
    "values": [
      "false"
    ],
    "source": "default"
  },
  {
    "name": "proxy.exclusion.list",
    "category": "Agent",
    "source": "default"
  }
]

Update the clock.skew property for the category Agent to 300000 milliseconds (5 minutes) by running the following command:

curl -i -X PATCH -u username:password -H Content-type:application/json http://host:port/wsm-pmrest/v2/configuration?platform={PlatformName}&domain={DomainName}

Example

curl -i -X PATCH -u Smith:Password  -H Content-type:application/json http://myhost:7001/wsm-pmrest/v2/configuration

See Set ConfigurationProperty(s).

The following shows an example of the request body.

[
  {
    "category": "Agent",
    "name": "clock.skew",
    "values": [
      "300000"
    ]
  }
]

The following shows an example of the response indicating the request succeeded.

{
  "STATUSCODE": "20032",
  "MESSAGE": "Configuration \"[clock.skew of Agent]\" are successfully updated."
}

Reset the values of clock.skew property to its default value by running the following command:

curl -i -X PATCH -u username:password -H Content-type:application/json http://host:port/wsm-pmrest/v2/configuration?platform={PlatformName}&domain={DomainName}

Example

curl -i -X PATCH -u Smith:Password  -H Content-type:application/json http://myhost:7001/wsm-pmrest/v2/configuration?platform=WLS&domain=base_domain

See Set ConfigurationProperty(s).

The following shows an example of the request body:

[  
  {  
    "category":"Agent",
    "name":"clock.skew",
    "values":[]
  }
]

The following shows an example of the response indicating the request succeeded.

{
  "STATUSCODE": "20032",
  "MESSAGE": "Configuration \"[clock.skew of Agent]\" are successfully updated."
}