Jump to

• Request
• Response

View This User Lockout Manager Runtime

get

/management/weblogic/{version}/serverRuntime/serverSecurityRuntime/defaultRealmRuntime/userLockoutManagerRuntime

View this user lockout manager runtime.

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 user lockout manager runtime.

This method can return the following links:

• rel=action title=clearLockout uri=/management/weblogic/{version}/serverRuntime/serverSecurityRuntime/defaultRealmRuntime/userLockoutManagerRuntime/clearLockout

  This resource's clearLockout action resource.

• rel=action title=getLastLoginFailure uri=/management/weblogic/{version}/serverRuntime/serverSecurityRuntime/defaultRealmRuntime/userLockoutManagerRuntime/getLastLoginFailure

  This resource's getLastLoginFailure action resource.

• rel=action title=getLoginFailureCount uri=/management/weblogic/{version}/serverRuntime/serverSecurityRuntime/defaultRealmRuntime/userLockoutManagerRuntime/getLoginFailureCount

  This resource's getLoginFailureCount action resource.

• rel=action title=isLockedOut uri=/management/weblogic/{version}/serverRuntime/serverSecurityRuntime/defaultRealmRuntime/userLockoutManagerRuntime/isLockedOut

  This resource's isLockedOut action resource.

Body ()

Root Schema : User Lockout Manager Runtime

Type: object

Show Source

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

  Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled. In a cluster, this method returns the number of invalid logins attempted that have occured since the cluster has been started because all servers share login failure information.

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

  Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts. Invalid login attempts expire as specified by LockoutResetDuration. This count is useful in determining whether the LockoutCacheSize needs to be modified.

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

  Returns the number of users that are currently locked out of this server.

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

  Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.

• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• unlockedUsersTotalCount(optional): integer(int64)
  Read Only: true

  Returns the number times users have been unlocked since this server has been started.

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

  Returns the number of user lockouts that have occured since this server has been started. In a cluster, this method returns the number of user lockouts that have occured since the cluster has been started because all servers share login failure information.

{
    "type":"object",
    "properties":{
        "invalidLoginAttemptsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.  In a cluster, this method returns the number of invalid logins attempted that have occured since the cluster has been started because all servers share login failure information.</p>"
        },
        "invalidLoginUsersHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts.  Invalid login attempts expire as specified by <code>LockoutResetDuration</code>. This count is useful in determining whether the <code>LockoutCacheSize</code> needs to be modified.</p>"
        },
        "lockedUsersCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of users that are currently locked out of this server.</p>"
        },
        "loginAttemptsWhileLockedTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "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>"
        },
        "unlockedUsersTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number times users have been unlocked since this server has been started.</p>"
        },
        "userLockoutTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of user lockouts that have occured since this server has been started.  In a cluster, this method returns the number of user lockouts that have occured since the cluster has been started because all servers share login failure information.</p>"
        }
    },
    "description":""
}

Back to Top