Jump to

• Request
• Response

View This Embedded LDAP

get

/management/weblogic/{version}/edit/embeddedLDAP

View this embedded LDAP.

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 embedded LDAP.

Body ()

Root Schema : Embedded LDAP

Type: object

Show Source

• anonymousBindAllowed(optional): boolean
  Default Value: false

  Specifies whether the embedded LDAP server should allow anonymous connections.

• backupCopies(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 65534

  Default Value: 7

  The maximum number of backup copies that should be made for the embedded LDAP server.

  This value limits the number of zip files in the ldap/backup directory.

• backupHour(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 23

  Default Value: 23

  The hour at which the embedded LDAP server should be backed up.

  The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.

• backupMinute(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 59

  Default Value: 5

  The minute at which the embedded LDAP server should be backed up.

  The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up

• cacheEnabled(optional): boolean
  Default Value: true

  Specifies whether a cache is used with the embedded LDAP server.

  This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.

• cacheSize(optional): integer(int32)
  Minimum Value: 0

  Default Value: 32

  The size of the cache (in kilobytes) that is used with the embedded LDAP server.

• cacheTTL(optional): integer(int32)
  Minimum Value: 0

  Default Value: 60

  The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.

• credential(optional): string(password)

  The credential (usually a password) used to connect to the embedded LDAP server.

  If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.

  As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

  1. Retrieves the value of the CredentialEncrypted attribute.

  2. Decrypts the value and returns the unencrypted password as a String.

  When you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.

  2. Sets the value of the CredentialEncrypted attribute to the encrypted value.

  Using the Credential attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

  Instead of using this attribute, use CredentialEncrypted()

• 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

• keepAliveEnabled(optional): boolean
  Default Value: false

  Whether keep alive is enabled in the socket connection

• masterFirst(optional): boolean
  Default Value: false

  Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).

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

• refreshReplicaAtStartup(optional): boolean
  Default Value: false

  Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• timeout(optional): integer(int32)
  Minimum Value: 0

  Default Value: 0

  Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "anonymousBindAllowed":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the embedded LDAP server should allow anonymous connections.</p>"
        },
        "backupCopies":{
            "default":7,
            "minimum":0,
            "maximum":65534,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of backup copies that should be made for the embedded LDAP server.</p><p>This value limits the number of zip files in the ldap/backup directory.</p>"
        },
        "backupHour":{
            "default":23,
            "minimum":0,
            "maximum":23,
            "type":"integer",
            "format":"int32",
            "description":"<p>The hour at which the embedded LDAP server should be backed up.</p><p>The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.</p>"
        },
        "backupMinute":{
            "default":5,
            "minimum":0,
            "maximum":59,
            "type":"integer",
            "format":"int32",
            "description":"<p>The minute at which the embedded LDAP server should be backed up.</p><p>The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up</p>"
        },
        "cacheEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether a cache is used with the embedded LDAP server.</p><p>This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.</p>"
        },
        "cacheSize":{
            "default":32,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The size of the cache (in kilobytes) that is used with the embedded LDAP server.</p>"
        },
        "cacheTTL":{
            "default":60,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.</p>"
        },
        "credential":{
            "type":"string",
            "format":"password",
            "description":"<p>The credential (usually a password) used to connect to the embedded LDAP server.</p><p>If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.</p><p>As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Retrieves the value of the <code>CredentialEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String.</p></li></ol><p>When you set the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>CredentialEncrypted</code> attribute to the encrypted value.</p></li></ol><p>Using the <code>Credential</code> attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.</p><p>Instead of using this attribute, use <code>CredentialEncrypted()</code></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>"
        },
        "keepAliveEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Whether keep alive is enabled in the socket connection</p>"
        },
        "masterFirst":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).</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>"
        },
        "refreshReplicaAtStartup":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "timeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.</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>"
}

Back to Top