ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>System Management>User Configuration
Get PDF

System Management


User Configuration


Create Account (CreateAccount)

API Request

URLs
POST zstack/v1/accounts
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "name": "test",     "password": "password",     "state": "Enabled"   },   "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 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()

Delete Account (DeleteAccount)

API Request

URLs
DELETE zstack/v1/accounts/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/accounts/0f4d2956d5ef35fc9c51ca45b09ba2bb
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url The resource UUID, uniquely identifying this resource 0.6
deleteMode (optional) String body Deletion mode 0.6
systemTags (optional) List body System tags 0.6
userTags (optional) List body User tags 0.6

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains an error field, for example:
{     "error": {         "code": "SYS.1001",         "description": "A message or a operation timeout",         "details": "Create VM on KVM timeout after 300s"     } }

SDK Examples

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

Update Account (UpdateAccount)

API Request

URLs
PUT zstack/v1/accounts/{uuid}
Headers
Authorization: OAuth the-session-uuid
Body
{   "updateAccount": {     "password": "updatepassword",     "name": "updatename"   },   "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 Example
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
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url The resource UUID, uniquely identifying this resource 0.6
password (optional) String body (contained in the updateAccount structure) Password 0.6
name (optional) String body (contained in the updateAccount structure) Account name 0.6
description (optional) String body (contained in the updateAccount structure) Detailed description of the resource 0.6
systemTags (optional) List body System tags 0.6
userTags (optional) List body User tags 0.6
oldPassword (optional) String body (contained in the updateAccount structure) 3.6.0
state (optional) String body (contained in the updateAccount structure) Account state
  • Enabled
  • Disabled
  • Staled
 4.3.0

API Response

Response example
{   "inventory": {     "uuid": "ffbf2fac53b83b838d4551edcaff1d39",     "name": "test",     "type": "Normal"   } }
Name Type Description Starting Version
success 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 state Account type 4.0.0
state state Account state 4.0.0
createDate Timestamp Creation time 4.0.0
lastOpDate Timestamp Last modification time 4.0.0

SDK Examples

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













































Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.