GET /userAccounts
Use GET to retrieve information about all user accounts.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/userAccounts
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 | Array of objects | 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 | The 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.
| ||
| pwdAge | Integer | Number of seconds 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.
| ||
| pwExpired | Boolean | Indicates if the password has expired. This can be one of the following values.
| ||
| reserved | Boolean | Indicates whether the user account is reserved for use by the XClarity Administrator. This can be one of the following values.
| ||
| state | String | User-account state. This can be one of the following values.
| ||
| supervisor | Boolean | Indicates whether the user is a supervisor. This can be one of the following values.
| ||
| 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.
| ||
| 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-04T11:58:38Z",
"description": "System Manager",
"groups": ["lxc-sysmgr"],
"id": "e1500a5d-7d78-464f-9b00-76d6ff8c3bc4",
"lastLoginTimestamp": "",
"ldapDn": "cn=SYSMGR_AXKVXE2I,ou=Users,dc=ibmbase,dc=com",
"loginAttempts": 1,
"loginCount": 1,
"modifyTimestamp": "2015-09-04T11:58:38Z",
"PasswordChangeFirstAccess": false,
"pwdAge": 635303,
"pwExpirationWarning": false,
"pwExpired": false,
"reserved": true,
"state": "Active",
"supervisor": false,
"timeBeforeExpirationInDays": 82,
"userName": "SYSMGR_AXKVXE2I",
"userPw": "NA"
},
...,
{
"activeSessions": 0,
"createTimestamp": "2015-07-20T17:02:26Z",
"description": "alanhawk",
"groups": ["lxc-supervisor"],
"id": "75d5aa42-266d-4241-ad5b-61f260dea827",
"lastLoginTimestamp": "",
"ldapDn": "cn=ALANHAWK,ou=Users,dc=ibmbase,dc=com",
"loginAttempts": 0
"loginCount": 0,
"modifyTimestamp": "2015-07-20T17:02:26Z",
"PasswordChangeFirstAccess": false,
"pwdAge": 4591474,
"pwExpirationWarning": false,
"pwExpired": false,
"reserved": false,
"state": "Active",
"supervisor": true,
"timeBeforeExpirationInDays": 36,
"userName": "ALANHAWK",
"userPw": "NA",
}],
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"explanation": "",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback