GET /userAccounts/{id}

Use GET to retrieve information about a specific user account.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/userAccounts/{id}

where {id} is the unique ID of the user to be retrieved. To obtain the user ID, use the GET /userAccounts method.

Query parameters

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
response Object Each array element represents a user account
  activeSessions Integer Number of currently active sessions for the user account
  createTimestamp String Date and time when the account was created. The timestamp is returned in ISO 8601 format, for example:
2014-02-05T15:54:13Z
  description String Description for the user account
  groups Array of strings List of role groups to which the user account belongs
  id String Hashed index uniquely identifying a user account
  lastLoginTimestamp String Date and time when the account was last successfully logged in. The timestamp is returned in ISO 8601 format. For example:
2014-02-05T15:54:13Z
  ldapDn String User's LDAP distinguished name, for example:
"cn=USERID,ou=Users,dc=ibmbase,dc=com"
  loginAttempts Integer Number of times that the user has attempted to log in
  loginCount Integer Number of times the user has successfully logged in
  modifyTimestamp String Date and time when the account was last modified. The timestamp is returned in ISO 8601 format, for example:
2014-02-05T15:54:13Z
  PasswordChangeFirstAccess Boolean Indicates if the user is required to change the password on the initial access. This can be one of the following values.
  • true. The password must be changed.
  • false. The password does not have to be changed.
  pwdAge Integer Number of days that have elapsed since the password was last changed
  pwExpirationWarning Boolean Indicates if a password expiration warning is to be displayed when a user logs in. This can be one of the following values.
  • true. The password warning is to be displayed.
  • false. The password has not expired.
  pwExpired Boolean Indicates if the password has expired. This can be one of the following values.
  • true. The password has expired.
  • false. The password has not expired.
  reserved Boolean Indicates whether the user account is reserved for use by the XClarity Administrator. This can be one of the following values.
  • true. The user account is reserved.
  • false. The user account is not reserved.
  state String User-account state. This can be one of the following values.
  • Active. The user account is in an active state.
  • Inactive. The user account is in an inactive state (disabled).
  • Locked. The user account is locked
  supervisor Boolean Indicates whether the user is a supervisor. This can be one of the following values.
  • true. The user account is a supervisor.
  • false. The user account is not a supervisor.
  timeBeforeExpirationInDays Integer Number of days remaining before a password expires
  userName String Name of the user account
  userPw String User password. This value is always NA.
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
messages Array of objects Information about one or more messages.
  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
  text String Message text associated with the message identifier
The following example is returned if the request is successful.
{
   "response": {
      "activeSessions": 0,
      "createTimestamp": "2015-09-16T19:11:43Z",
      "description": "",
      "groups": ["lxc-supervisor"],
      "id": "a74ce309-9167-4320-b7d0-83fb70df8131",
      "lastLoginTimestamp": "",
      "ldapDn": "cn=ADMINSITRATOR,ou=Users,dc=ibmbase,dc=com",
      "loginAttempts": 0,
      "loginCount": 0,
      "modifyTimestamp": "2015-09-16T19:11:43Z",
      "PasswordChangeFirstAccess": false,
      "pwdAge": 69837,
      "pwExpirationWarning": false,
      "pwExpired": false,
      "reserved": false,
      "state": "Active",
      "supervisor": true,
      "timeBeforeExpirationInDays": 89,
      "userName": "ADMIN",
      "userPw": "NA"
   },
   "result": "success",
   "messages": [{
      "explanation": "",
      "id": "FQXHMSE0001I",
      "recovery": {
         "text": "Information only; no action is required.",
         "URL": ""
      },
      "text": "The request completed successfully."
   }]
}