POST /userAccounts
Use this method to create a user account.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/userAccounts
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description |
|---|---|---|---|
| userName | Required | String | User name |
| userPw | Required | String | Initial account password |
| description | Optional | String | Description for the user account |
| groups | Required | Array of strings | List of role groups to which this user account belongs. This can be one of the following values.
|
| PasswordChangeFirstAccess | Optional | Boolean | Indicates if the password must be changed when the user initially accesses the XClarity Administrator. This can be one of the following values.
If not specified, the default value is taken from the user account settings (see /userAccountSettings). |
Request example
{
"userPw": "passw0rd",
"userName": "test2",
"description": "test2 description",
"groups": ["lxc-admin"],
"PasswordChangeFirstAccess": true
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 201 | Created | One or more new resources were successfully created. |
| 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. |
| 409 | Conflict | There is a conflict with the current state of the resource. 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 | 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 forma (for example, 2014-02-05T15:54:13Z). | ||
| description | String | Description for the user account | ||
| fullName | String | Descriptive name of the user account (for example: First M Last) | ||
| 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. he 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 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 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 status. 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 | Internal use only | ||
| result | String | Request results. 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": {
"createTimestamp": "2015-01-05T22:28:28Z",
"description": "test2 description",
"groups": ["lxc-admin"],
"id": "478e6564-066a-4714-b734-e0f5c3073fbf",
"lastLoginTimestamp": "",
"ldapDn": "cn=TEST2,ou=Users,dc=ibmbase,dc=com",
"loginAttempts": 0,
"loginCount": 0,
"modifyTimestamp": "2015-01-05T22:28:28Z",
"PasswordChangeFirstAccess": true,
"pwdAge": 0,
"pwExpirationWarning": false,
"pwExpired": true,
"state": "Active",
"timeBeforeExpirationInDays": 90,
"userName": "TEST2",
"userPw": "NA"
},
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback