Jump to

• Request
• Response

View This Secure Mode

get

/management/weblogic/{version}/serverConfig/securityConfiguration/secureMode

View this secure mode.

Request

Path Parameters

• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this secure mode.

Body ()

Root Schema : Secure Mode

Type: object

Show Source

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• restrictiveJMXPolicies(optional): boolean
  Default Value: true

  Returns whether restrictive policies will be used for JMX authorization.

  If secure mode is enabled and restrictive policies are enabled, then the default policies for JMX only allow MBean access to the standard WLS roles (Admin, Deployer, Operator, or Monitor). If changed as part of a non-dynamic activation, then the ServerSecurityRuntimeMBean.resetDefaultPolicies method should also be invoked.

• secureModeEnabled(optional): boolean
  Default Value: false

  Returns whether the domain will run in secure mode.

  In secure mode, the configuration defaults are those recommended for securing a domain. The authorization policies for JNDI and MBean access are more restrictive in secure mode. In addition, WLS will validate the domain configuration and log warnings and errors for any insecure settings.

  Secure mode requires the domain to be in production mode.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• warnOnAuditing(optional): boolean
  Default Value: true

  Returns whether warnings should be logged if auditing not enabled.

  If secure mode is enabled and warnings are enabled, then messages will be logged if auditing is not enabled.

• warnOnInsecureApplications(optional): boolean
  Default Value: true

  Returns whether warnings should be logged if applications are not secure.

  If secure mode is enabled and warnings are enabled, then messages will be logged for insecure application elements.

• warnOnInsecureFileSystem(optional): boolean
  Default Value: true

  Returns whether warnings should be logged if the File System is not secure.

  If secure mode is enabled and warnings are enabled, then messages will be logged for insecure file system setting.

• warnOnInsecureSSL(optional): boolean
  Default Value: true

  Returns whether warnings should be logged if the SSL configuration is not secure.

  If secure mode is enabled and warnings are enabled, then messages will be logged for insecure SSL configuration settings.

• warnOnJavaSecurityManager(optional): boolean
  Default Value: true

  Returns whether warnings should be logged if the Java Security Manager is not enabled.

  If secure mode is enabled and warning is enabled, then a messages will be logged if the Java Security Manager is not enabled.

{
    "type":"object",
    "properties":{
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "restrictiveJMXPolicies":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether restrictive policies will be used for JMX authorization.</p><p>If secure mode is enabled and restrictive policies are enabled, then the default policies for JMX only allow MBean access to the standard WLS roles (Admin, Deployer, Operator, or Monitor). If changed as part of a non-dynamic activation, then the ServerSecurityRuntimeMBean.resetDefaultPolicies method should also be invoked. </p>"
        },
        "secureModeEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Returns whether the domain will run in secure mode.</p><p>In secure mode, the configuration defaults are those recommended for securing a domain. The authorization policies for JNDI and MBean access are more restrictive in secure mode. In addition, WLS will validate the domain configuration and log warnings and errors for any insecure settings.</p><p> Secure mode requires the domain to be in production mode. </p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "warnOnAuditing":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether warnings should be logged if auditing not enabled. </p><p>If secure mode is enabled and warnings are enabled, then messages will be logged if auditing is not enabled.</p>"
        },
        "warnOnInsecureApplications":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether warnings should be logged if applications are not secure. </p><p>If secure mode is enabled and warnings are enabled, then messages will be logged for insecure application elements.</p>"
        },
        "warnOnInsecureFileSystem":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether warnings should be logged if the File System is not secure. </p><p>If secure mode is enabled and warnings are enabled, then messages will be logged for insecure file system setting.</p>"
        },
        "warnOnInsecureSSL":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether warnings should be logged if the SSL configuration is not secure. </p><p>If secure mode is enabled and warnings are enabled, then messages will be logged for insecure SSL configuration settings.</p>"
        },
        "warnOnJavaSecurityManager":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether warnings should be logged if the Java Security Manager is not enabled. </p><p>If secure mode is enabled and warning is enabled, then a messages will be logged if the Java Security Manager is not enabled.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top