Create Account

POST/zstack/v1/accounts

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "test",
    "password": "password",
    "state": "Enabled"
  },
  "systemTags": [],
  "userTags": []
}

In the above example, the systemTags and userTags fields can be omitted. They are listed to show that these two fields can be included in the body.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"test","password":"password","state":"Enabled"}}' \
http://localhost:8080/zstack/v1/accounts

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
name	String	body (contained in the `params` structure)	Resource name		0.6
password	String	body (contained in the `params` structure)	Password		0.6
type (optional)	String	body (contained in the `params` structure)	Account type	SystemAdmin Normal	0.6
description (optional)	String	body (contained in the `params` structure)	Detailed description of the resource		0.6
resourceUuid (optional)	String	body (contained in the `params` structure)	Resource UUID		0.6
systemTags (optional)	List	body	System tags		0.6
userTags (optional)	List	body	User tags		0.6
tagUuids (optional)	List	body (contained in the `params` structure)	Tag UUID list		4.3.0
state (optional)	String	body (contained in the `params` structure)	Account state	Enabled Disabled Staled	4.3.0

API Response

Response example

{
  "inventory": {
    "uuid": "77dc15220f71377ea48fa520d40d9169",
    "name": "test",
    "type": "Normal"
  }
}

Name	Type	Description	Starting Version
sucess	boolean		0.6
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error	0.6
inventory	AccountInventory	For details, see inventory	0.6

error

Name	Type	Description	Starting Version
code	String	The error code number, a globally unique identifier for the error, e.g., SYS.1000, HOST.1001	0.6
description	String	A brief description of the error	0.6
details	String	The detailed error information	0.6
elaboration	String	Reserved field. Defaults to null	0.6
opaque	LinkedHashMap	Reserved field. Defaults to null	0.6
cause	ErrorCode	The root error, the cause of the current error. This field is null if there is no root error	0.6

inventory

Name	Type	Description	Starting Version
uuid	String	The account UUID, uniquely identifying this resource	4.0.0
name	String	Account name	4.0.0
description	String	Detailed description of the account	4.0.0
type	String	Account type	4.0.0
state	String	Account state	4.0.0
createDate	Timestamp	Creation time	4.0.0
lastOpDate	Timestamp	Last modification time	4.0.0

SDK Examples

Java SDK

CreateAccountAction action = new CreateAccountAction();
action.name = "test";
action.password = "password";
action.state = "Enabled";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateAccountAction.Result res = action.call();

Python SDK

CreateAccountAction action = CreateAccountAction()
action.name = "test"
action.password = "password"
action.state = "Enabled"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateAccountAction.Result res = action.call()