Jump to

• Request
• Response

Modify This Remote Console Helper

post

/management/weblogic/{version}/edit/remoteConsoleHelper

Modify this remote console helper.

Request

Supported Media Types

• application/json

Path Parameters

• version(required): string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By(required): string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified remote console helper model.

Root Schema : Remote Console Helper

Type: object

Show Source

• contextPath: string
  Default Value: console

  The context path used in URLs that specify the Remote Console Helper.

• cookieName: string
  Default Value: REMOTECONSOLESESSION

  The cookie name used by the Remote Console Helper.

• dynamicallyCreated: boolean
  Read Only: true

  Default Value: false

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

• id: integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name: 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: 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.

• protectedCookieEnabled: boolean
  Default Value: true

  Determine if the Remote Console Helper session cookie is protected so that it is only visible to the helper. This may prevent use of this shared cookie in other applications.

• restrictContentBasedOnRoles: boolean
  Default Value: true

  Determines whether the hosted Remote Console restricts pages and actions based on the current user's WebLogic Server role. When this attribute is disabled, the Remote Console displays all content, but WebLogic Server authorization continues to enforce access. Role-based content restrictions use the default security policies and might not reflect custom security policy changes.

• sessionTimeout: integer(int32)
  Default Value: 600

  The session timeout value (in seconds) for the Remote Console Helper.

• tags: array Items
  Title: Items

  Return all tags on this Configuration MBean

• tokenTimeout: integer(int32)
  Default Value: 60

  The token timeout (in minutes) of the user token from the Remote Console Helper.

• type: string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "contextPath":{
            "default":"console",
            "type":"string",
            "description":"<p>The context path used in URLs that specify the Remote Console Helper. </p>"
        },
        "cookieName":{
            "default":"REMOTECONSOLESESSION",
            "type":"string",
            "description":"<p>The cookie name used by the Remote Console Helper. </p>"
        },
        "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>"
        },
        "protectedCookieEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Determine if the Remote Console Helper session cookie is protected so that it is only visible to the helper. This may prevent use of this shared cookie in other applications.</p>"
        },
        "restrictContentBasedOnRoles":{
            "default":true,
            "type":"boolean",
            "description":"<p>Determines whether the hosted Remote Console restricts pages and actions based on the current user's WebLogic Server role. When this attribute is disabled, the Remote Console displays all content, but WebLogic Server authorization continues to enforce access. Role-based content restrictions use the default security policies and might not reflect custom security policy changes.</p>"
        },
        "sessionTimeout":{
            "default":600,
            "type":"integer",
            "format":"int32",
            "description":"<p>The session timeout value (in seconds) for the Remote Console Helper. </p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "tokenTimeout":{
            "default":60,
            "type":"integer",
            "format":"int32",
            "description":"<p>The token timeout (in minutes) of the user token from the Remote Console Helper. </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>"
        }
    },
    "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>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

200 Response

Back to Top