Organization Operations

CreateIAM2Organization

API Request

URLs

POST /v1/iam2/organizations

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "org1",     "type": "Company",     "parentUuid": "b24b468d502f4d7e949dfcdf9036879c",     "attributes": [       {         "name": "some-attribute-name",         "value": "attribute-value"       }     ]   },   "systemTags": [],   "userTags": [] }

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"org1","type":"Company","parentUuid":"1c26fe0d3e384ac9bf67ce4340d65413","attributes":[{"name":"some-attribute-name","value":"attribute-value"}]}}' http://localhost:8080/zstack/v1/iam2/organizations

Request Parameters

Name	Type	Location	Description	Optional Value	Starting Version
name	String	body (contained in the params structure)	The resource name.		2.4.0
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.		2.4.0
type	OrganizationType	body (contained in the params structure)	The organization type.	Company Department	2.4.0
parentUuid	String	body (contained in the params structure)	Optional.		2.4.0
attributes	List	body (contained in the params structure)	Optional.		2.4.0
resourceUuid	String	body (contained in the params structure)	Optional.		2.4.0
systemTags	List	body	Optional.		2.4.0
userTags	List	body	Optional.		2.4.0

API Response

Sample Response

{   "inventory": {     "uuid": "c623821bf32a4a9ea6e8e6839de79473",     "name": "org1",     "state": "Enabled",     "type": "Company",     "parentUuid": "58b7f5a391b64d189ba79217758cd30e",     "attributes": [       {         "uuid": "b058dd2b053540faa97eb80e13b41970",         "name": "attribute-name",         "value": "attribute-value",         "type": "Customized"       }     ]   } }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	2.4.0
inventory	IAM2OrganizationInventory	See inventory.	2.4.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	2.4.0
description	String	The brief description of the error.	2.4.0
details	String	The details about the error.	2.4.0
elaboration	String	The reserved field. Default value: null.	2.4.0
opaque	LinkedHashMap	The reserved field. Default value: null.	2.4.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	2.4.0

#inventory

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	2.4.0
name	String	The resource name.	2.4.0
description	String	The detailed description of the resource.	2.4.0
createDate	Timestamp	The creation date.	2.4.0
lastOpDate	Timestamp	The last operation date.	2.4.0
parentUuid	String		2.4.0
state	State	See state.	2.4.0
type	OrganizationType	See type.	2.4.0
attributes	List	See attributes.	2.4.0

#state

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

#type

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

#attributes

Name	Type	Description	Starting Version
organizationUuid	String		2.4.0
uuid	String	The resource UUID.	2.4.0
name	String	The resource name.	2.4.0
value	String		2.4.0
type	AttributeType	See type.	2.4.0

#type

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

SDK Sample

Java SDK

CreateIAM2OrganizationAction action = new CreateIAM2OrganizationAction(); action.name = "org1"; action.type = "Company"; action.parentUuid = "1d650e96108c47a297a7529d45afef97"; action.attributes = asList([name:some-attribute-name, value:attribute-value]); action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateIAM2OrganizationAction.Result res = action.call();

Python SDK

CreateIAM2OrganizationAction action = CreateIAM2OrganizationAction() action.name = "org1" action.type = "Company" action.parentUuid = "a7faaafa84ae4345957fd7e61434481b" action.attributes = [[name:some-attribute-name, value:attribute-value]] action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateIAM2OrganizationAction.Result res = action.call()

DeleteIAM2Organization

API Request

URLs

DELETE /v1/iam2/organizations/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/iam2/organizations/b30d1f09a0df3f708bba1208ade2aa90?deleteMode=Permissive

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource UUID.	2.4.0
deleteMode	String	url	Optional.	2.4.0
systemTags	List	body	Optional.	2.4.0
userTags	List	body	Optional.	2.4.0

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes 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 Sample

Java SDK

DeleteIAM2OrganizationAction action = new DeleteIAM2OrganizationAction(); action.uuid = "b30d1f09a0df3f708bba1208ade2aa90"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteIAM2OrganizationAction.Result res = action.call();

Python SDK

DeleteIAM2OrganizationAction action = DeleteIAM2OrganizationAction() action.uuid = "b30d1f09a0df3f708bba1208ade2aa90" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteIAM2OrganizationAction.Result res = action.call()

QueryIAM2Organization

API Request

URLs

GET zstack/v1/iam2/organizations

GET zstack/v1/iam2/organizations/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

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

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

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryIAM2Organization, and pressing the Tab key.

API Response

Sample Response

{   "inventories": [     {       "uuid": "22e5c247ec02478286a1fccfdaa9a2d3",       "name": "org1",       "state": "Enabled",       "type": "Company",       "parentUuid": "3714d14d9b78487e983236a5ae65a190",       "attributes": [         {           "uuid": "ee3bccfce21243cfbfc03cce1118b929",           "name": "attribute-name",           "value": "attribute-value",           "type": "Customized"         }       ]     }   ] }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	2.4.0
inventories	List	See inventories.	2.4.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	2.4.0
description	String	The brief description of the error.	2.4.0
details	String	The details about the error.	2.4.0
elaboration	String	The reserved field. Default value: null.	2.4.0
opaque	LinkedHashMap	The reserved field. Default value: null.	2.4.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	2.4.0

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	2.4.0
name	String	The resource name.	2.4.0
description	String	The detailed description of the resource.	2.4.0
createDate	Timestamp	The creation date.	2.4.0
lastOpDate	Timestamp	The last operation date.	2.4.0
parentUuid	String		2.4.0
state	State	See state.	2.4.0
type	OrganizationType	See type.	2.4.0
attributes	List	See attributes.	2.4.0

#state

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

#type

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

#attributes

Name	Type	Description	Starting Version
organizationUuid	String		2.4.0
uuid	String	The resource UUID.	2.4.0
name	String	The resource name.	2.4.0
value	String		2.4.0
type	AttributeType	See type.	2.4.0

#type

Name	Type	Description	Starting Version
name	String	The resource name.	2.4.0
ordinal	int		2.4.0

SDK Sample

Java SDK

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

Python SDK

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

Enterprise Management (Plus)