Jump to

• Request
• Response

View This User Lockout Manager

get

/management/weblogic/{version}/serverConfig/securityConfiguration/realms/{name}/userLockoutManager

View this user lockout manager.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• 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 user lockout manager.

This method can return the following links:

• rel=realm

  This resource's realm reference to a realm resource.

Body ()

Root Schema : User Lockout Manager

Type: object

Show Source

• lockoutCacheSize(optional): integer(int64)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 5

  Returns the number of invalid login records that the server places in a cache. The server creates one record for each invalid login.

• lockoutDuration(optional): integer(int64)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 30

  Returns the number of minutes that a user account is locked out.

• lockoutEnabled(optional): boolean
  Default Value: true

  Returns whether the server locks out users when there are invalid login attempts. A true value for this attribute causes the server to consider the other attributes of this MBean. A false value causes the server to ignore the other attributes of this MBean."

• lockoutGCThreshold(optional): integer(int64)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 400

  Returns the maximum number of invalid login records that the server keeps in memory.

  If the number of invalid login records is equal to or greater than this value, the server's garbage collection purges the records that have expired. A record expires when the user associated with the record has been locked out.

  The lower the threshold, the more often the server uses its resources to collect garbage.

• lockoutResetDuration(optional): integer(int64)
  Minimum Value: 1

  Maximum Value: 2147483647

  Default Value: 5

  The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.

• lockoutThreshold(optional): integer(int64)
  Minimum Value: 1

  Maximum Value: 2147483647

  Default Value: 5

  Returns the maximum number of consecutive invalid login attempts before account is locked out. When the number of invalid logins within a specified period of time is greater than LockoutThresholdvalue, the user is locked out. For example, with the default setting of , the user is locked out on the second consecutive invalid login. With a setting of , the user is locked out on the third consecutive invalid login.

• name(optional): string
  Read Only: true

  Default Value: UserLockoutManager

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

• realm(optional): array Realm Reference
  Title: Realm Reference

  Read Only: true

  Contains the realm reference.

  Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.

{
    "type":"object",
    "properties":{
        "lockoutCacheSize":{
            "default":5,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of invalid login records that the server places in a cache. The server creates one record for each invalid login.</p>"
        },
        "lockoutDuration":{
            "default":30,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of minutes that a user account is locked out.</p>"
        },
        "lockoutEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns whether the server locks out users when there are invalid login attempts.  A <code>true</code> value for this attribute causes the server to consider the other attributes of this MBean. A <code>false</code> value causes the server to ignore the other attributes of this MBean.\"</p>"
        },
        "lockoutGCThreshold":{
            "default":400,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the maximum number of invalid login records that the server keeps in memory.</p><p>If the number of invalid login records is equal to or greater than this value, the server's garbage collection purges the records that have expired. A record expires when the user associated with the record has been locked out.</p><p>The lower the threshold, the more often the server uses its resources to collect garbage.</p>"
        },
        "lockoutResetDuration":{
            "default":5,
            "minimum":1,
            "maximum":2147483647,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.</p>"
        },
        "lockoutThreshold":{
            "default":5,
            "minimum":1,
            "maximum":2147483647,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the maximum number of consecutive invalid login attempts before account is locked out.  When the number of invalid logins within a specified period of time is greater than <code>LockoutThreshold</code>value, the user is locked out. For example, with the default setting of <code></code>, the user is locked out on the second consecutive invalid login. With a setting of <code></code>, the user is locked out on the third consecutive invalid login.</p>"
        },
        "name":{
            "readOnly":true,
            "default":"UserLockoutManager",
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p>"
        },
        "realm":{
            "readOnly":true,
            "title":"Realm Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the realm reference. <p>Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.</p>"
        }
    },
    "description":""
}

Nested Schema : Realm Reference

Type: array

Title: Realm Reference

Read Only: true

Contains the realm reference.

Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Realm Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the realm reference. <p>Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.</p>"
}

Back to Top