POST zstack/v1/accounts

Authorization: OAuth the-session-uuid

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

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

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

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

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

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

DELETE zstack/v1/accounts/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/accounts/0f4d2956d5ef35fc9c51ca45b09ba2bb

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

DeleteAccountAction action = new DeleteAccountAction();
action.uuid = "0f4d2956d5ef35fc9c51ca45b09ba2bb";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteAccountAction.Result res = action.call();

DeleteAccountAction action = DeleteAccountAction()
action.uuid = "0f4d2956d5ef35fc9c51ca45b09ba2bb"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteAccountAction.Result res = action.call()

PUT zstack/v1/accounts/{uuid}

Authorization: OAuth the-session-uuid

{
  "updateAccount": {
    "password": "updatepassword",
    "name": "updatename"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X PUT -d '{"updateAccount":{"password":"updatepassword","name":"updatename"}}' http://localhost:8080/zstack/v1/accounts/99fcb2ad540c36f09e87c820ac6cb4cb

{
  "inventory": {
    "uuid": "ffbf2fac53b83b838d4551edcaff1d39",
    "name": "test",
    "type": "Normal"
  }
}

UpdateAccountAction action = new UpdateAccountAction();
action.uuid = "99fcb2ad540c36f09e87c820ac6cb4cb";
action.password = "updatepassword";
action.name = "updatename";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateAccountAction.Result res = action.call();

action = UpdateAccountAction()
action.uuid = "99fcb2ad540c36f09e87c820ac6cb4cb"
action.password = "updatepassword"
action.name = "updatename"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/accounts
GET zstack/v1/accounts/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/accounts?q=name=test

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/accounts/fa37d4ea030937b797cb97b2ea09840b

{
  "inventories": [
    {
      "uuid": "5c4b1e96b2833c2db31c5d7f175c817d",
      "name": "test",
      "type": "Normal"
    }
  ]
}

QueryAccountAction action = new QueryAccountAction();
action.conditions = asList("name=test");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAccountAction.Result res = action.call();

action = QueryAccountAction()
action.conditions = ["name=test"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT zstack/v1/accounts/login

{
  "logInByAccount": {
    "accountName": "test",
    "password": "password",
    "captchaUuid": "39bd748906ad301793c64f688dc197a9",
    "verifyCode": "test"
  },
  "systemTags": [],
  "userTags": []
}

Note: 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 -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"logInByAccount":{"accountName":"test","password":"password","captchaUuid":"39bd748906ad301793c64f688dc197a9","verifyCode":"test"}}' \
http://localhost:8080/zstack/v1/accounts/login

{
  "inventory": {
    "uuid": "5d77893e242d39ec8b9856a7b8762eab",
    "accountUuid": "7ab57f322e4a396b8124ed4fda810966",
    "expiredDate": "Nov 14, 2017 2:20:57 PM",
    "noSessionEvaluation": false
  }
}

LogInByAccountAction action = new LogInByAccountAction();
action.accountName = "test";
action.password = "password";
action.captchaUuid = "39bd748906ad301793c64f688dc197a9";
action.verifyCode = "test";
LogInByAccountAction.Result res = action.call();

LogInByAccountAction action = LogInByAccountAction()
action.accountName = "test"
action.password = "password"
action.captchaUuid = "39bd748906ad301793c64f688dc197a9"
action.verifyCode = "test"
LogInByAccountAction.Result res = action.call()

POST zstack/v1/zcenter/accounts/sessions

Authorization: OAuth the-session-uuid

{
  "params": {
    "accountName": "test1",
    "source": "Local"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X POST -d '{"params":{"accountName":"test1","source":"Local"}}' http://localhost:8080/zstack/v1/zcenter/accounts/sessions

{
  "inventory": {
    "uuid": "ff06305f62fd3b17a7e2c67628a08700",
    "accountUuid": "ff0b33166633399aae77ea258d2f7900",
    "expiredDate": "Nov 15, 2017 2:20:57 PM",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "noSessionEvaluation": false
  }
}

CreateSessionForZCenterAccountAction action = new CreateSessionForZCenterAccountAction();
action.accountName = "test1";
action.source = "Local";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSessionForZCenterAccountAction.Result res = action.call();

action = CreateSessionForZCenterAccountAction()
action.accountName = "test1"
action.source = "Local"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/login/control/captcha

curl -H "Content-Type: application/json;charset=UTF-8" -X GET http://localhost:8080/zstack/v1/login/control/captcha?resourceName=admin&loginType=Test

{
  "captchaUuid": "ff0c9fd9ea99333aa9f47cf61b5f0900",
  "captcha": "test"
}

GetLoginCaptchaAction action = new GetLoginCaptchaAction();
action.resourceName = "admin";
action.loginType = "Test";
GetLoginCaptchaAction.Result res = action.call();

action = GetLoginCaptchaAction()
action.resourceName = "admin"
action.loginType = "Test"
res = action.call()

GET zstack/v1/captcha/refresh

curl -H "Content-Type: application/json;charset=UTF-8" -X GET http://localhost:8080/zstack/v1/captcha/refresh

RefreshCaptchaAction action = new RefreshCaptchaAction();
RefreshCaptchaAction.Result res = action.call();

RefreshCaptchaAction action = RefreshCaptchaAction()
RefreshCaptchaAction.Result res = action.call()

GET zstack/v1/twofactorauthentication/secret

curl -H "Content-Type: application/json;charset=UTF-8" \
-X GET http://localhost:8080/zstack/v1/twofactorauthentication/secret?name=user1&password=password&type=ldap

{
  "inventory": {
    "uuid": "7870dee14bdb328c9eb6635f4f494fdd",
    "secret": "ABCDEFGH12345678",
    "status": "NewCreated",
    "userType": "AccountVO"
  }
}

GetTwoFactorAuthenticationSecretAction action = new GetTwoFactorAuthenticationSecretAction();
action.name = "user1";
action.password = "password";
action.type = "ldap";
GetTwoFactorAuthenticationSecretAction.Result res = action.call();

action = GetTwoFactorAuthenticationSecretAction()
action.name = "user1"
action.password = "password"
action.type = "ldap"
res = action.call()

GET zstack/v1/twofactorauthentication/secrets

GET zstack/v1/twofactorauthentication/secrets/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/twofactorauthentication/secrets?q=uuid=d65b4896eee23175b19e1267ee39ec60

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/twofactorauthentication/secrets/83358cec65073cbc876ddefe3d9b69fe

{
  "inventories": [
    {
      "uuid": "16620c01d20b390891ae1a1bc072ac0b",
      "secret": "ABCDEFGH12345678",
      "userUuid": "264d446f00e43793a2b0dcd21c367aaf",
      "userType": "AccountVO",
      "status": "NewCreated"
    }
  ]
}

QueryTwoFactorAuthenticationAction action = new QueryTwoFactorAuthenticationAction();
action.conditions = asList("uuid=4875201ba7443dddb51e336f9a23a20e");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryTwoFactorAuthenticationAction.Result res = action.call();

QueryTwoFactorAuthenticationAction action = QueryTwoFactorAuthenticationAction()
action.conditions = ["uuid=ccf0f6cdf5a73bf7b961869f9bd8ca25"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryTwoFactorAuthenticationAction.Result res = action.call()

GET zstack/v1/twofactorauthentication/state

curl -H "Content-Type: application/json;charset=UTF-8" -X GET http://localhost:8080/zstack/v1/twofactorauthentication/state

{
  "state": "Disable"
}

GetTwoFactorAuthenticationStateAction action = new GetTwoFactorAuthenticationStateAction();
GetTwoFactorAuthenticationStateAction.Result res = action.call();

GetTwoFactorAuthenticationStateAction action = GetTwoFactorAuthenticationStateAction()
GetTwoFactorAuthenticationStateAction.Result res = action.call()

PUT zstack/v1/twofactorauthentication/secrets

Authorization: OAuth the-session-uuid

{
  "resetTwoFactorAuthenticationSecret": {
    "name": "user1",
    "password": "password",
    "type": "ldap"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"resetTwoFactorAuthenticationSecret":{"name":"user1","password":"password","type":"ldap"}}' \
http://localhost:8080/zstack/v1/twofactorauthentication/secrets

ResetTwoFactorAuthenticationSecretAction action = new ResetTwoFactorAuthenticationSecretAction();
action.name = "user1";
action.password = "password";
action.type = "ldap";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ResetTwoFactorAuthenticationSecretAction.Result res = action.call();

action = ResetTwoFactorAuthenticationSecretAction()
action.name = "user1"
action.password = "password"
action.type = "ldap"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/accounts/resources/refs

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/accounts/resources/refs?q=acountUuid=279c136f406e35a6a6874e39b231a2d3

{
  "inventories": [
    {
      "id": 1,
      "accountUuid": "ef9a9b4c5bd338768f18148dbfe42f1c",
      "resourceUuid": "6e06fe5d204f30ac80ffc4c2d6372e46",
      "resourceType": "ImageVO",
      "type": "Own"
    }
  ]
}

QueryAccountResourceRefAction action = new QueryAccountResourceRefAction();
action.conditions = asList("acountUuid=dec9472c2f9b3f6abaa84ed78094171c");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAccountResourceRefAction.Result res = action.call();

QueryAccountResourceRefAction action = QueryAccountResourceRefAction()
action.conditions = ["acountUuid=05e51ebc332935769868ecde43b8f8e6"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAccountResourceRefAction.Result res = action.call()

POST zstack/v1/account-groups

Authorization: OAuth the-session-uuid

{
  "params": {
    "name": "my-group"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"my-group"}}' \
http://localhost:8080/zstack/v1/account-groups

{
  "inventory": {
    "uuid": "98cab5e804424603892af30a1f7a4a58",
    "name": "my-group",
    "description": "my-group-description",
    "rootGroupUuid": "98cab5e804424603892af30a1f7a4a58",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

CreateAccountGroupAction action = new CreateAccountGroupAction();
action.name = "my-group";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateAccountGroupAction.Result res = action.call();

CreateAccountGroupAction action = CreateAccountGroupAction()
action.name = "my-group"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateAccountGroupAction.Result res = action.call()

DELETE zstack/v1/account-groups/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/account-groups/8dac6a80b68b3f7fbe44233dfe42a1d8

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DeleteAccountGroupAction action = new DeleteAccountGroupAction();
action.uuid = "8dac6a80b68b3f7fbe44233dfe42a1d8";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteAccountGroupAction.Result res = action.call();

DeleteAccountGroupAction action = DeleteAccountGroupAction()
action.uuid = "8dac6a80b68b3f7fbe44233dfe42a1d8"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteAccountGroupAction.Result res = action.call()

PUT zstack/v1/account-groups/{uuid}/actions

Authorization: OAuth the-session-uuid

{
  "updateAccountGroup": {
    "name": "my-group"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateAccountGroup":{"name":"my-group"}}' \
http://localhost:8080/zstack/v1/account-groups/0e830b9be4e33dd7b772eb9316ee6fb1/actions

{
  "inventory": {
    "uuid": "14295ba5c00d4fc596541e3fb5652924",
    "name": "my-group",
    "description": "my-group-description",
    "rootGroupUuid": "14295ba5c00d4fc596541e3fb5652924",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

UpdateAccountGroupAction action = new UpdateAccountGroupAction();
action.uuid = "0e830b9be4e33dd7b772eb9316ee6fb1";
action.name = "my-group";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateAccountGroupAction.Result res = action.call();

UpdateAccountGroupAction action = UpdateAccountGroupAction()
action.uuid = "0e830b9be4e33dd7b772eb9316ee6fb1"
action.name = "my-group"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateAccountGroupAction.Result res = action.call()

PUT zstack/v1/account-groups/{uuid}/actions

Authorization: OAuth the-session-uuid

{
  "moveAccountGroup": {
    "parentUuid": "996c8a1d6f273903b750254a69ec5a7b"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"moveAccountGroup":{"parentUuid":"996c8a1d6f273903b750254a69ec5a7b"}}' \
http://localhost:8080/zstack/v1/account-groups/efdbcd5b10ee3b9aa6b61f2ec4a0efcb/actions

{
  "inventory": {
    "uuid": "c4f2348db99a4d64ac5319abecff4427",
    "name": "my-group",
    "description": "my-group-description",
    "rootGroupUuid": "c4f2348db99a4d64ac5319abecff4427",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

MoveAccountGroupAction action = new MoveAccountGroupAction();
action.uuid = "efdbcd5b10ee3b9aa6b61f2ec4a0efcb";
action.parentUuid = "996c8a1d6f273903b750254a69ec5a7b";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
MoveAccountGroupAction.Result res = action.call();

MoveAccountGroupAction action = MoveAccountGroupAction()
action.uuid = "efdbcd5b10ee3b9aa6b61f2ec4a0efcb"
action.parentUuid = "996c8a1d6f273903b750254a69ec5a7b"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
MoveAccountGroupAction.Result res = action.call()

GET zstack/v1/account-groups
GET zstack/v1/account-groups/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/account-groups?q=name=my-group

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/account-groups/64fb6148cb6438a088febdd75b819245

{
  "inventories": [
    {
      "uuid": "c7e4d70aa27b49839516c7ed9d3651a8",
      "name": "my-group",
      "description": "my-group-description",
      "rootGroupUuid": "c7e4d70aa27b49839516c7ed9d3651a8",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

QueryAccountGroupAction action = new QueryAccountGroupAction();
action.conditions = asList("name=my-group");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAccountGroupAction.Result res = action.call();

QueryAccountGroupAction action = QueryAccountGroupAction()
action.conditions = ["name=my-group"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAccountGroupAction.Result res = action.call()

POST zstack/v1/account-groups/{groupUuid}/accounts

Authorization: OAuth the-session-uuid

{
  "params": {
    "accountUuids": [
      "ac243dc036043ad7a1ea649248e3e863"
    ]
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"accountUuids":["ac243dc036043ad7a1ea649248e3e863"]}}'
http://localhost:8080/zstack/v1/account-groups/ab8c60e7c3bb3f05906adfc8f991c90b/accounts

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

AddAccountToGroupAction action = new AddAccountToGroupAction();
action.groupUuid = "ab8c60e7c3bb3f05906adfc8f991c90b";
action.accountUuids = asList("ac243dc036043ad7a1ea649248e3e863");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddAccountToGroupAction.Result res = action.call();

AddAccountToGroupAction action = AddAccountToGroupAction()
action.groupUuid = "ab8c60e7c3bb3f05906adfc8f991c90b"
action.accountUuids = [ac243dc036043ad7a1ea649248e3e863]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddAccountToGroupAction.Result res = action.call()

DELETE zstack/v1/account-groups/{groupUuid}/accounts

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/account-groups/263094628051388c80bb011a63d070f1/accounts

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

RemoveAccountFromGroupAction action = new RemoveAccountFromGroupAction();
action.groupUuid = "263094628051388c80bb011a63d070f1";
action.accountUuids = asList("0bc44812c44d314482e0fa4389271117");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveAccountFromGroupAction.Result res = action.call();

RemoveAccountFromGroupAction action = RemoveAccountFromGroupAction()
action.groupUuid = "263094628051388c80bb011a63d070f1"
action.accountUuids = [0bc44812c44d314482e0fa4389271117]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveAccountFromGroupAction.Result res = action.call()

POST zstack/v1/account-groups/{groupUuid}/roles

Authorization: OAuth the-session-uuid

{
  "params": {
    "roleUuids": [
      "314c999460493f589963a021e0478054"
    ]
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"roleUuids":["314c999460493f589963a021e0478054"]}}' \
http://localhost:8080/zstack/v1/account-groups/c271dab858c63bd288502e9ee4e0498d/roles

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

AttachRoleToAccountGroupAction action = new AttachRoleToAccountGroupAction();
action.groupUuid = "c271dab858c63bd288502e9ee4e0498d";
action.roleUuids = asList("314c999460493f589963a021e0478054");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachRoleToAccountGroupAction.Result res = action.call();

AttachRoleToAccountGroupAction action = AttachRoleToAccountGroupAction()
action.groupUuid = "c271dab858c63bd288502e9ee4e0498d"
action.roleUuids = [314c999460493f589963a021e0478054]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachRoleToAccountGroupAction.Result res = action.call()

DELETE zstack/v1/account-groups/{groupUuid}/roles

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/account-groups/28c89d7eaf23373baad7e0f8889b2c3d/roles

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DetachRoleFromAccountGroupAction action = new DetachRoleFromAccountGroupAction();
action.groupUuid = "28c89d7eaf23373baad7e0f8889b2c3d";
action.roleUuids = asList("b63ab325307535a9b918d5b76b1246f5");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachRoleFromAccountGroupAction.Result res = action.call();

DetachRoleFromAccountGroupAction action = DetachRoleFromAccountGroupAction()
action.groupUuid = "28c89d7eaf23373baad7e0f8889b2c3d"
action.roleUuids = [b63ab325307535a9b918d5b76b1246f5]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachRoleFromAccountGroupAction.Result res = action.call()

GET zstack/v1/account-groups/tree

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/account-groups/tree?groupUuid=470ce4d7a8dc32f597aa77675da3cd08&level=0&showGroup=true&showAccount=true

{
  "inventory": {
    "groupUuid": "ff0b3ed5c5d7323b9150ffd45a820a00",
    "groupName": "my-group",
    "inventory": {
      "uuid": "ff0b3ed5c5d7323b9150ffd45a820a00",
      "name": "my-group",
      "description": "my-group-description",
      "rootGroupUuid": "ff0b3ed5c5d7323b9150ffd45a820a00",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    },
    "accounts": [
      {
        "uuid": "ff0b33166633399aae77ea258d2f7900",
        "name": "account1",
        "description": "account1-description",
        "type": "Normal",
        "source": "Local",
        "state": "Enabled",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "groups": [
      {
        "groupUuid": "ff0b3ed5c5d7323b9150ffd45a820a00",
        "groupName": "child-group",
        "accounts": [],
        "groups": []
      }
    ]
  }
}

GetAccountGroupTreeAction action = new GetAccountGroupTreeAction();
action.groupUuid = "470ce4d7a8dc32f597aa77675da3cd08";
action.level = 0;
action.showGroup = true;
action.showAccount = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetAccountGroupTreeAction.Result res = action.call();

action = GetAccountGroupTreeAction()
action.groupUuid = "470ce4d7a8dc32f597aa77675da3cd08"
action.level = 0
action.showGroup = true
action.showAccount = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/account-groups/{groupUuid}/resources

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/account-groups/07954c2a73cf348383db3ccdecbb94fa/resources?includeInheritedResources=false

{
  "currentGroup": {
    "groupUuid": "f34e8f7c5ae84dc2902c4c54a1eb957b",
    "groupName": "my-group",
    "resources": [
      {
        "uuid": "1783b75964da46bda91fe6ee371c8bd0",
        "resourceName": "vm1",
        "resourceType": "VmInstanceVO"
      }
    ]
  }
}

GetResourceInAccountGroupAction action = new GetResourceInAccountGroupAction();
action.groupUuid = "ff0b3ed5c5d7323b9150ffd45a820a00";
action.includeInheritedResources = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceInAccountGroupAction.Result res = action.call();

action = GetResourceInAccountGroupAction()
action.groupUuid = "ff0b3ed5c5d7323b9150ffd45a820a00"
action.includeInheritedResources = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/accounts/quotas

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/accounts/quotas?q=name=test

{
  "inventories": [
    {
      "name": "quota",
      "identityUuid": "b30cc832a5493fe2a6184a78fc20c410",
      "value": 20
    }
  ]
}

QueryQuotaAction action = new QueryQuotaAction();
action.conditions = asList("name=test");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryQuotaAction.Result res = action.call();

QueryQuotaAction action = QueryQuotaAction()
action.conditions = ["name=test"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryQuotaAction.Result res = action.call()

PUT zstack/v1/accounts/quotas/actions

Authorization: OAuth the-session-uuid

{
  "updateQuota": {
    "identityUuid": "4d45e6c7787733979415760d2077fca0",
    "name": "quotaname",
    "value": 20
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateQuota":{"identityUuid":"4d45e6c7787733979415760d2077fca0","name":"quotaname","value":20}}' \
http://localhost:8080/zstack/v1/accounts/quotas/actions

{
  "inventory": {
    "name": "quota",
    "identityUuid": "733689237dd9309f81e6a2f76b7c78b1",
    "value": 20
  }
}

UpdateQuotaAction action = new UpdateQuotaAction();
action.identityUuid = "4d45e6c7787733979415760d2077fca0";
action.name = "quotaname";
action.value = 20;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateQuotaAction.Result res = action.call();

UpdateQuotaAction action = UpdateQuotaAction()
action.identityUuid = "4d45e6c7787733979415760d2077fca0"
action.name = "quotaname"
action.value = 20
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateQuotaAction.Result res = action.call()

GET zstack/v1/resources/names

Authorization: OAuth the-session-uuid

curl  -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/resources/names?uuids=393ce06589043e33b397bc21043e8cd4&uuids=b62bdb31280a30a69c2f110bac8cb682

{
  "inventories": [
    {
      "uuid": "9da599e443ec3d21bb4c766ad51784d3",
      "resourceName": "zone",
      "resourceType": "ZoneVO"
    },
    {
      "uuid": "a6e1b35c657835c5972e94773e52949b",
      "resourceName": "vm",
      "resourceType": "VmInstanceVO"
    }
  ]
}

GetResourceNamesAction action = new GetResourceNamesAction();
action.uuids = asList("393ce06589043e33b397bc21043e8cd4","b62bdb31280a30a69c2f110bac8cb682");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceNamesAction.Result res = action.call();

GetResourceNamesAction action = GetResourceNamesAction()
action.uuids = [393ce06589043e33b397bc21043e8cd4, b62bdb31280a30a69c2f110bac8cb682]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetResourceNamesAction.Result res = action.call()

GET zstack/v1/iam1/resource-ensemble/view-sharing

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam1/resource-ensemble/view-sharing

{
  "uuid": "a2a658dba2fa385382bc9f29a0788815",
  "toPublic": false,
  "accounts": [
    {
      "uuid": "7ded05202370411d85e6bf20168fa08f"
    }
  ],
  "accountGroups": [
    {
      "uuid": "2347044abdbb41d6b2bfb3cd196bfe79"
    }
  ]
}

GetResourceSharingAction action = new GetResourceSharingAction();
action.uuid = "8fa73dc3301333e0aa39de406406831f";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceSharingAction.Result res = action.call();

GetResourceSharingAction action = GetResourceSharingAction()
action.uuid = "8fa73dc3301333e0aa39de406406831f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetResourceSharingAction.Result res = action.call()

PUT zstack/v1/account-groups/resources/actions

Authorization: OAuth the-session-uuid

{
  "shareResourceToGroup": {
    "resourceUuids": [
      "7f610aa37f17327d9b1dd74fc4ce871d"
    ],
    "groupUuid": "2334f9ef50f03f2dba17abb79c6b5d53"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"shareResourceToGroup":{"resourceUuids":["7f610aa37f17327d9b1dd74fc4ce871d"],"groupUuid":"2334f9ef50f03f2dba17abb79c6b5d53"}}' \
http://localhost:8080/zstack/v1/account-groups/resources/actions

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

ShareResourceToGroupAction action = new ShareResourceToGroupAction();
action.resourceUuids = asList("7f610aa37f17327d9b1dd74fc4ce871d");
action.groupUuid = "2334f9ef50f03f2dba17abb79c6b5d53";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ShareResourceToGroupAction.Result res = action.call();

ShareResourceToGroupAction action = ShareResourceToGroupAction()
action.resourceUuids = [7f610aa37f17327d9b1dd74fc4ce871d]
action.groupUuid = "2334f9ef50f03f2dba17abb79c6b5d53"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ShareResourceToGroupAction.Result res = action.call()

PUT zstack/v1/account-groups/resources/actions

Authorization: OAuth the-session-uuid

{
  "revokeResourceSharingToGroup": {
    "resourceUuids": [
      "3d502ce7557c3aa29f40ab4cfde80bbd"
    ],
    "groupUuid": "c84e3415faca3a94971b14ba5b4dceb2"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"revokeResourceSharingToGroup":{"resourceUuids":["3d502ce7557c3aa29f40ab4cfde80bbd"],"groupUuid":"c84e3415faca3a94971b14ba5b4dceb2"}}' \
http://localhost:8080/zstack/v1/account-groups/resources/actions

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

RevokeResourceSharingToGroupAction action = new RevokeResourceSharingToGroupAction();
action.resourceUuids = asList("3d502ce7557c3aa29f40ab4cfde80bbd");
action.groupUuid = "c84e3415faca3a94971b14ba5b4dceb2";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RevokeResourceSharingToGroupAction.Result res = action.call();

RevokeResourceSharingToGroupAction action = RevokeResourceSharingToGroupAction()
action.resourceUuids = [3d502ce7557c3aa29f40ab4cfde80bbd]
action.groupUuid = "c84e3415faca3a94971b14ba5b4dceb2"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RevokeResourceSharingToGroupAction.Result res = action.call()

GET zstack/v1/iam1/resource-ensemble
GET zstack/v1/iam1/resource-ensemble/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam1/resource-ensemble?uuid=14c61568f49a45759c9a75c8fea4f854

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam1/resource-ensemble/14c61568f49a45759c9a75c8fea4f854?uuid=14c61568f49a45759c9a75c8fea4f854

{
  "inventory": {
    "masterUuid": "14c61568f49a45759c9a75c8fea4f854",
    "masterResourceName": "VM1",
    "masterResourceType": "VmInstanceVO",
    "members": [
      {
        "uuid": "c1abb7bd0de8489bb183d829c3ccde0e",
        "resourceName": "vmcdrom-VM1",
        "resourceType": "VmCdRomVO"
      },
      {},
      {}
    ]
  }
}

GetResourceEnsembleMembersAction action = new GetResourceEnsembleMembersAction();
action.uuid = "14c61568f49a45759c9a75c8fea4f854";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceEnsembleMembersAction.Result res = action.call();

GetResourceEnsembleMembersAction action = GetResourceEnsembleMembersAction()
action.uuid = "14c61568f49a45759c9a75c8fea4f854"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetResourceEnsembleMembersAction.Result res = action.call()

PUT zstack/v1/accounts/resources/actions

Authorization: OAuth the-session-uuid

{
  "shareResource": {
    "resourceUuids": [
      "62113cf71892442daf57fe1a21606e7b",
      "e8d14f0a61d7497c83cf9451bdd392a3"
    ],
    "accountUuids": [
      "17c6a138e5f04df4ad8938fa8bd06340",
      "7063dc465e7c42739fdb5fd7d3e373f4"
    ],
    "toPublic": false
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"shareResource":{"resourceUuids":["05c5cdd1a5693e53ad3212a69b808883","49c6493b8eaf3765806aeb17071e779f"],"accountUuids":["62c084e3a2053b089b8b95fe452856e7","194f8c7d98963e628b9967b0df7eecae"],"toPublic":false}}' \
http://localhost:8080/zstack/v1/accounts/resources/actions

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

ShareResourceAction action = new ShareResourceAction();
action.resourceUuids = asList("05c5cdd1a5693e53ad3212a69b808883","49c6493b8eaf3765806aeb17071e779f");
action.accountUuids = asList("62c084e3a2053b089b8b95fe452856e7","194f8c7d98963e628b9967b0df7eecae");
action.toPublic = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ShareResourceAction.Result res = action.call();

ShareResourceAction action = ShareResourceAction()
action.resourceUuids = [05c5cdd1a5693e53ad3212a69b808883, 49c6493b8eaf3765806aeb17071e779f]
action.accountUuids = [62c084e3a2053b089b8b95fe452856e7, 194f8c7d98963e628b9967b0df7eecae]
action.toPublic = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ShareResourceAction.Result res = action.call()

PUT zstack/v1/accounts/resources/actions

Authorization: OAuth the-session-uuid

{
  "revokeResourceSharing": {
    "resourceUuids": [
      "6551ce5374243f14875351219cdb69ba",
      "18501632374c331692e10ab976f56e28"
    ],
    "toPublic": false,
    "accountUuids": [
      "9a0c56a8bcbd31edbd384b28b8ffeffc",
      "3627b63ad55939cf8df5fa4848abd6f2"
    ],
    "all": false
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"revokeResourceSharing":{"resourceUuids":["6551ce5374243f14875351219cdb69ba","18501632374c331692e10ab976f56e28"],"toPublic":false,"accountUuids":["9a0c56a8bcbd31edbd384b28b8ffeffc","3627b63ad55939cf8df5fa4848abd6f2"],"all":false}}' \
http://localhost:8080/zstack/v1/accounts/resources/actions

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

RevokeResourceSharingAction action = new RevokeResourceSharingAction();
action.resourceUuids = asList("6551ce5374243f14875351219cdb69ba","18501632374c331692e10ab976f56e28");
action.toPublic = false;
action.accountUuids = asList("9a0c56a8bcbd31edbd384b28b8ffeffc","3627b63ad55939cf8df5fa4848abd6f2");
action.all = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RevokeResourceSharingAction.Result res = action.call();

RevokeResourceSharingAction action = RevokeResourceSharingAction()
action.resourceUuids = [6551ce5374243f14875351219cdb69ba, 18501632374c331692e10ab976f56e28]
action.toPublic = false
action.accountUuids = [9a0c56a8bcbd31edbd384b28b8ffeffc, 3627b63ad55939cf8df5fa4848abd6f2]
action.all = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RevokeResourceSharingAction.Result res = action.call()

POST zstack/v1/account/{accountUuid}/resources

Authorization: OAuth the-session-uuid

{
  "params": {
    "resourceUuid": "abfee8286ae43b19a02179cfe37b3294"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"resourceUuid":"abfee8286ae43b19a02179cfe37b3294"}}' \
http://localhost:8080/zstack/v1/account/e9da3eb01abc31c78ac24dec8c8c36b5/resources

{
  "inventory": {
    "id": 1,
    "accountUuid": "819950c427763deca51c94ad5e06da42",
    "resourceUuid": "844a5dbbd2a632678b67a610e4d761b6",
    "resourceType": "ImageVO",
    "type": "Own"
  }
}

ChangeResourceOwnerAction action = new ChangeResourceOwnerAction();
action.accountUuid = "e9da3eb01abc31c78ac24dec8c8c36b5";
action.resourceUuid = "abfee8286ae43b19a02179cfe37b3294";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeResourceOwnerAction.Result res = action.call();

ChangeResourceOwnerAction action = ChangeResourceOwnerAction()
action.accountUuid = "e9da3eb01abc31c78ac24dec8c8c36b5"
action.resourceUuid = "abfee8286ae43b19a02179cfe37b3294"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeResourceOwnerAction.Result res = action.call()

GET zstack/v1/resources/accounts

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/resources/accounts?resourceUuids=59fc59531b6639b3b0bd6263b021df4c&resourceUuids=77115316d36839e9b1a4f832f38de8ba

{
  "inventories": {
    "db4e395223813bafa838ce4285a78757": {
      "uuid": "ef68adaf368335ab8d15a4c2195749a7",
      "name": "test",
      "type": "Normal"
    },
    "736ee9f80a2230658e999c17e5be1835": {
      "uuid": "ef68adaf368335ab8d15a4c2195749a7",
      "name": "test",
      "type": "Normal"
    }
  }
}

GetResourceAccountAction action = new GetResourceAccountAction();
action.resourceUuids = asList("59fc59531b6639b3b0bd6263b021df4c","77115316d36839e9b1a4f832f38de8ba");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceAccountAction.Result res = action.call();

action = GetResourceAccountAction()
action.resourceUuids = [59fc59531b6639b3b0bd6263b021df4c, 77115316d36839e9b1a4f832f38de8ba]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET zstack/v1/accounts/sessions/{sessionUuid}/valid

curl -H "Content-Type: application/json;charset=UTF-8" \
-X GET http://localhost:8080/zstack/v1/accounts/sessions/525912127c633468b4fe142528ee3f3b/valid

{
  "validSession": true
}

ValidateSessionAction action = new ValidateSessionAction();
action.sessionUuid = "525912127c633468b4fe142528ee3f3b";
ValidateSessionAction.Result res = action.call();

ValidateSessionAction action = ValidateSessionAction()
action.sessionUuid = "525912127c633468b4fe142528ee3f3b"
ValidateSessionAction.Result res = action.call()

PUT zstack/v1/login

Authorization: OAuth the-session-uuid

{
  "logIn": {
    "username": "admin",
    "password": "password",
    "loginType": "iam1"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"logIn":{"username":"admin","password":"password","loginType":"iam1"}}' \
http://localhost:8080/zstack/v1/login

{
  "inventory": {
    "uuid": "5d77893e242d39ec8b9856a7b8762eab",
    "accountUuid": "7ab57f322e4a396b8124ed4fda810966",
    "expiredDate": "Nov 14, 2017 2:20:57 PM",
    "noSessionEvaluation": false
  }
}

LogInAction action = new LogInAction();
action.username = "admin";
action.password = "password";
action.loginType = "iam1";
LogInAction.Result res = action.call();

LogInAction action = LogInAction()
action.username = "admin"
action.password = "password"
action.loginType = "iam1"
LogInAction.Result res = action.call()

PUT zstack/v1/accounts/sessions/{sessionUuid}/renew

Authorization: OAuth the-session-uuid

{
  "renewSession": {
    "duration": 100
  },
  "systemTags": [],
  "userTags": []
}

Note: In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"renewSession":{"duration":100}}' \
http://localhost:8080/zstack/v1/accounts/sessions/7b93b7648aea3c8d9109498a32288470/renew

{
  "inventory": {
    "uuid": "dce673d8c6d53988b188b4ac34e7304d",
    "accountUuid": "fa58814a623d3778a8c91d11b74c6d38",
    "expiredDate": "Nov 14, 2017 2:20:57 PM",
    "noSessionEvaluation": false
  }
}

RenewSessionAction action = new RenewSessionAction();
action.sessionUuid = "7b93b7648aea3c8d9109498a32288470";
action.duration = 100;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RenewSessionAction.Result res = action.call();

RenewSessionAction action = RenewSessionAction()
action.sessionUuid = "7b93b7648aea3c8d9109498a32288470"
action.duration = 100
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RenewSessionAction.Result res = action.call()

DELETE zstack/v1/accounts/sessions/{sessionUuid}

curl -H "Content-Type: application/json;charset=UTF-8" \
-X DELETE http://localhost:8080/zstack/v1/accounts/sessions/77b3af8ddd67334ebdec0b2e32d1559b

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

LogOutAction action = new LogOutAction();
action.sessionId = "0c7e729fb59945938752cd4ec99c2a94";
LogOutAction.Result res = action.call();

LogOutAction action = LogOutAction()
action.sessionId = "1cb84b3f5713432aaf42bc230c32aa20"
LogOutAction.Result res = action.call()

DELETE zstack/v1/identities/roles/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/identities/roles/6576d603b86634d68d49e9df50443e7f

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DeleteRoleAction action = new DeleteRoleAction();
action.uuid = "6576d603b86634d68d49e9df50443e7f";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteRoleAction.Result res = action.call();

DeleteRoleAction action = DeleteRoleAction()
action.uuid = "6576d603b86634d68d49e9df50443e7f"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteRoleAction.Result res = action.call()

GET zstack/v1/identities/roles
GET zstack/v1/identities/roles/{uuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/identities/roles

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/identities/roles/159398ac7d57325daeb62f4abbc5107b

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

QueryRoleAction action = new QueryRoleAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryRoleAction.Result res = action.call();

QueryRoleAction action = QueryRoleAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryRoleAction.Result res = action.call()

GET zstack/v1/identities/role/policy-actions

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/identities/role/policy-actions?showAllPolicies=false

{
  "policies": [
    ".header.identity.APIChangeResourceOwnerMsg",
    ".header.identity.APICheckResourcePermissionMsg",
    ".header.identity.APICreateAccountMsg",
    ".header.identity.APIDeleteAccountMsg",
    ".header.identity.APIGetAccountQuotaUsageMsg",
    ".header.identity.APIGetResourceAccountMsg",
    ".header.identity.APILogInByAccountMsg",
    ".header.identity.APILogOutMsg",
    ".header.identity.APIQueryAccountMsg",
    ".header.identity.APIQueryAccountResourceRefMsg",
    ".header.identity.APIQueryQuotaMsg",
    ".header.identity.APIRenewSessionMsg",
    ".header.identity.APIRevokeResourceSharingMsg",
    ".header.identity.APIShareResourceMsg",
    ".header.identity.APIUpdateAccountMsg",
    ".header.identity.APIUpdateQuotaMsg",
    ".header.identity.APIValidateSessionMsg"
  ]
}

GetRolePolicyActionsAction action = new GetRolePolicyActionsAction();
action.showAllPolicies = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetRolePolicyActionsAction.Result res = action.call();

GetRolePolicyActionsAction action = GetRolePolicyActionsAction()
action.showAllPolicies = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetRolePolicyActionsAction.Result res = action.call()

GET zstack/v1/identities/role-account-refs

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/identities/role-account-refs?q=roleUuid=686cb963323e491e955a0fd0b49dd743

{
  "inventories": [
    {
      "roleUuid": "686cb963323e491e955a0fd0b49dd743",
      "accountUuid": "5360250ef145409e862b4e99d2b2efc4",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

QueryRoleAccountRefAction action = new QueryRoleAccountRefAction();
action.conditions = asList("roleUuid=686cb963323e491e955a0fd0b49dd743");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryRoleAccountRefAction.Result res = action.call();

QueryRoleAccountRefAction action = QueryRoleAccountRefAction()
action.conditions = ["roleUuid=686cb963323e491e955a0fd0b49dd743"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryRoleAccountRefAction.Result res = action.call()

POST zstack/v1/identities/accounts/{accountUuid}/roles/{roleUuid}

Authorization: OAuth the-session-uuid

{
  "params": {},
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields are optional. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/identities/accounts/053a25bbfe2c34a889d75601e64d4a51/roles/b7a901c45db33f12993c9c7aad874ff4

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

AttachRoleToAccountAction action = new AttachRoleToAccountAction();
action.roleUuid = "b7a901c45db33f12993c9c7aad874ff4";
action.accountUuid = "053a25bbfe2c34a889d75601e64d4a51";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachRoleToAccountAction.Result res = action.call();

AttachRoleToAccountAction action = AttachRoleToAccountAction()
action.roleUuid = "b7a901c45db33f12993c9c7aad874ff4"
action.accountUuid = "053a25bbfe2c34a889d75601e64d4a51"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachRoleToAccountAction.Result res = action.call()

DELETE zstack/v1/identities/accounts/{accountUuid}/roles/{roleUuid}

Authorization: OAuth the-session-uuid

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/identities/accounts/ac3ea9154a603cbcabbb1664dbcf66ef/roles/ca3f332b7ffd347fa30ba01be1176b96

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DetachRoleFromAccountAction action = new DetachRoleFromAccountAction();
action.roleUuid = "ca3f332b7ffd347fa30ba01be1176b96";
action.accountUuid = "ac3ea9154a603cbcabbb1664dbcf66ef";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachRoleFromAccountAction.Result res = action.call();

DetachRoleFromAccountAction action = DetachRoleFromAccountAction()
action.roleUuid = "ca3f332b7ffd347fa30ba01be1176b96"
action.accountUuid = "ac3ea9154a603cbcabbb1664dbcf66ef"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachRoleFromAccountAction.Result res = action.call()

POST zstack/v1/crypto/ccs-certificate/attach-account/{accountUuid}

Authorization: OAuth the-session-uuid

{
  "params": {
    "certificateUuid": "37efdf76b03a3028926549ea5f1253f3",
    "state": "enable"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields are optional. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"certificateUuid":"37efdf76b03a3028926549ea5f1253f3","state":"enable"}}' \
http://localhost:8080/zstack/v1/crypto/ccs-certificate/attach-account/e0deabb1107f32e7b715d6b5e7f39334

{
  "inventory": {
    "uuid": "271c21f7ef8c4385b09846341cc9deac",
    "algorithm": "SM2",
    "format": "CER",
    "issuerDN": "C\u003dcn,O\u003dinfosec,OU\u003dsystem,CN\u003dca62_sm2",
    "subjectDN": "C\u003dCN,O\u003dZStack,OU\u003dZStack,CN\u003dZStackTest2",
    "serNumber": "13055887750776402041",
    "effectiveTime": "Oct 15, 2021 10:50:09 AM",
    "expirationTime": "Oct 15, 2024 10:50:09 AM"
  }
}

AttachCCSCertificateToAccountAction action = new AttachCCSCertificateToAccountAction();
action.certificateUuid = "37efdf76b03a3028926549ea5f1253f3";
action.accountUuid = "e0deabb1107f32e7b715d6b5e7f39334";
action.state = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachCCSCertificateToAccountAction.Result res = action.call();

AttachCCSCertificateToAccountAction action = AttachCCSCertificateToAccountAction()
action.certificateUuid = "37efdf76b03a3028926549ea5f1253f3"
action.accountUuid = "e0deabb1107f32e7b715d6b5e7f39334"
action.state = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachCCSCertificateToAccountAction.Result res = action.call()

POST zstack/v1/crypto/ccs-certificate/detach-account/{accountUuid}

Authorization: OAuth the-session-uuid

{
  "params": {},
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields are optional. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/crypto/ccs-certificate/detach-account/0f708fb369393654acdf1f145a2408c2

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

DetachCCSCertificateFromAccountAction action = new DetachCCSCertificateFromAccountAction();
action.accountUuid = "0f708fb369393654acdf1f145a2408c2";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachCCSCertificateFromAccountAction.Result res = action.call();

DetachCCSCertificateFromAccountAction action = DetachCCSCertificateFromAccountAction()
action.accountUuid = "0f708fb369393654acdf1f145a2408c2"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachCCSCertificateFromAccountAction.Result res = action.call()

POST zstack/v1/crypto/ccs-certificate/update-state/{accountUuid}

Authorization: OAuth the-session-uuid

{
  "params": {
    "state": "enable"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields are optional. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"state":"enable"}}' \
http://localhost:8080/zstack/v1/crypto/ccs-certificate/update-state/c418d26244b43e31bfe400652695f62a

{
  "inventory": {
    "uuid": "4e1cab9a3a0f4a1eb6a919510814d8f8",
    "algorithm": "SM2",
    "format": "CER",
    "issuerDN": "C\u003dcn,O\u003dinfosec,OU\u003dsystem,CN\u003dca62_sm2",
    "subjectDN": "C\u003dCN,O\u003dZStack,OU\u003dZStack,CN\u003dZStackTest2",
    "serNumber": "13055887750776402041",
    "effectiveTime": "Oct 15, 2021 10:50:09 AM",
    "expirationTime": "Oct 15, 2024 10:50:09 AM"
  }
}

UpdateCCSCertificateAccountStateAction action = new UpdateCCSCertificateAccountStateAction();
action.accountUuid = "c418d26244b43e31bfe400652695f62a";
action.state = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateCCSCertificateAccountStateAction.Result res = action.call();

UpdateCCSCertificateAccountStateAction action = UpdateCCSCertificateAccountStateAction()
action.accountUuid = "c418d26244b43e31bfe400652695f62a"
action.state = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateCCSCertificateAccountStateAction.Result res = action.call()

PUT zstack/v1/accounts/{uuid}/actions

Authorization: OAuth the-session-uuid

{
  "changeAccountType": {
    "type": "SystemAdmin"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeAccountType":{"type":"SystemAdmin"}}' \
http://localhost:8080/zstack/v1/accounts/f0c72e5b9d723dbaa716d2f0fad341d9/actions

ChangeAccountTypeAction action = new ChangeAccountTypeAction();
action.uuid = "f0c72e5b9d723dbaa716d2f0fad341d9";
action.type = "SystemAdmin";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeAccountTypeAction.Result res = action.call();

action = ChangeAccountTypeAction()
action.uuid = "f0c72e5b9d723dbaa716d2f0fad341d9"
action.type = "SystemAdmin"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()