CreateIAM2Organization

Creates an organization. For example,

>CreateIAM2Organization name=cloud type=Department

Parameters

Name	Description	Optional	Valid Value	Starting Version
name	The resource name.			2.4.0
description	The detailed description of the resource.	Yes		2.4.0
type	The organization type.		Company Department	2.4.0
parentUuid		Yes		2.4.0
attributes		Yes		2.4.0
resourceUuid		Yes		2.4.0
quota	The quota.	Yes		4.3.6
userTags	The user tags. For more information, see CreateUserTag.	Yes		2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		2.4.0
timeout		Yes

DeleteIAM2Organization

Deletes an organization. For example,

DeleteIAM2Organization uuid=a9665c1515c04619a2d2078519c4ee40

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.4.0
deleteMode		Yes	2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

QueryIAM2Organization

Queries an organization. For example,

QueryIAM2Organization name=cloud

Primitive Fields of Query

See Organization Inventory.

Nested And Expanded Fields of Query

Field	Inventory	Description	Starting Version
attributes	Attribute Inventory	The attributes.	2.4.0
virtualIDs	Virtual ID Inventory	The users that belong to the organization.	2.4.0

UpdateIAM2Organization

Updates an organization. For example,

UpdateIAM2Organization uuid=e3342a520bc44d5abea4f1bf65503556

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The resource UUID.			2.4.0
name	The resource name.	Yes		2.4.0
description	The detailed description of the resource.	Yes		2.4.0
parentUuid		Yes		2.4.0
type		Yes	Company Department	2.4.0
userTags	The user tags, For more information, see CreateUserTag.	Yes		2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		2.4.0
timeout		Yes

ChangeIAM2OrganizationParent

Changes the parent department in an organization. For example,

ChangeIAM2OrganizationParent parentUuid=4400321828a74631acd3229bbfb37440 childrenUuids=e3342a520bc44d5abea4f1bf65503556

Parameters

Name	Description	Optional	Starting Version
parentUuid	The parent department UUID.		2.4.0
childrenUuids	The subsidiary department UUID.		2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

ChangeIAM2OrganizationState

Changes the state of an organization. For example,

ChangeIAM2OrganizationState uuid=4400321828a74631acd3229bbfb37440 stateEvent=disable

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The resource UUID.			2.4.0
stateEvent			Enable Disable	2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		2.4.0
timeout		Yes

RemoveAttributesFromIAM2Organization

Removes attributes from an organization. For example,

RemoveAttributesFromIAM2Organization uuid=4400321828a74631acd3229bbfb37440 attributeUuids=a9665c1515c04619a2d2078519c4ee40

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.4.0
attributeUuids	The attribute UUIDs.		2.4.0
userTags	TH user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

RemoveIAM2VirtualIDsFromOrganization

Removes a user from an organization. For example,

RemoveIAM2VirtualIDsFromOrganization virtualIDUuids=fd15790e88c248c6a654859c15ee3022 organizationUuid=b74113ceeffd48878f3c1ab50ba7c11a

Parameters

Name	Description	Optional	Starting Version
virtualIDUuids			2.4.0
organizationUuid			2.4.0
userTags	The user tags. For more information, see CreateUserTag	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

CreateIAM2VirtualID

Creates a user. For example,

CreateIAM2VirtualID name=user password=password

Parameters

Name	Description	Optional	Starting Version
name	The user name.		2.4.0
password			2.4.0
description		Yes	2.4.0
attributes		Yes	2.4.0
projectUuid		Yes	2.4.0
organizationUuid		Yes	2.4.0
resourceUuid		Yes	2.4.0
tagUuids	The tag UUID list.	Yes	3.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

DeleteIAM2VirtualID

Deletes a user. For example,

DeleteIAM2VirtualID uuid=b141cd136a1f384d9e8e68319f8e1281

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.4.0
deleteMode		Yes	2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

QueryIAM2VirtualID

Queries a user. For example,

QueryIAM2VirtualID name=user

Primitive Fields of Query

See Virtual ID Inventory.

Nested and Expanded Fields of Query

Field	Inventory	Description	Starting Version
attributes	Attributes Inventory	The user attributes.	2.4.0
groups	Virtual ID Group Inventory	The member group to which the user belongs.	2.4.0
organizations	Organization Inventory	The organization to which the user belongs.	2.4.0
projects	Project Inventory	The project to which the user belongs.	2.4.0
roles	Roles Inventory	The permissions owned by the user as a member.	2.4.0

LoginIAM2VirtualID

Logs in to the cloud as a user. For example,

LoginIAM2VirtualID name=user password=password

# Use two-factor authentication.
LoginIAM2VirtualID name=user password=password systemTags=twofatoken::123456

Parameters

Name	Description	Optional	Starting Version
name	The resource name.		2.4.0
password			2.4.0
captchaUuid		Yes	2.4.0
verifyCode		Yes	2.4.0
clientInfo	The client information.	Yes	3.5.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

Note:

When you log in to ZStack Cloud as a user, you can use the two-factor authentication method by adding the twofatoken option to SystemTags.
- Format of the twofatoken option: twofatoken::6-digit two-factor authentication code
- Example: twofatoken::123456

ChangeIAM2VirtualIDState

Changes the state of a user. For example,

ChangeIAM2VirtualIDState uuid=cc723702dcc24fafba542aa64d953d58 stateEvent=enable

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The resource UUID.			2.4.0
stateEvent			enable disable	2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		2.4.0
timeout		Yes

AddIAM2VirtualIDsToOrganization

Adds a user to an organization. For example,

AddIAM2VirtualIDsToOrganization virtualIDUuids=e747d2bd298c38aab5ac7ee561377845 organizationUuid=e28067165c7a3d098ea64c564ac2f53f

Parameters

Name	Description	Optional	Starting Version
virtualIDUuids			2.4.0
organizationUuid			2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

AddAttributesToIAM2VirtualID

Adds attributes to a user. For example,

AddAttributesToIAM2VirtualID uuid=94d943b468573d9d9cdfd5472a6235dc attributes='[{"name":"__ProjectAdmin__", "value":"feddc59f327240eea305942cf00ef491"}]'

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.4.0
attributes	The attributes.		2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

RemoveAttributesFromIAM2VirtualID

Removes attributes from a user. For example,

RemoveAttributesFromIAM2VirtualID uuid=041a44d7d5983fe480c577c897b08eb7 attributeUuids=4d06d2b6742636dfaed60ea4b8807aa2

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.4.0
attributeUuids			2.4.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.4.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.4.0
timeout		Yes

SetOrganizationSupervisor

Sets an organization supervisor. For example,

SetOrganizationSupervisor uuid=25a96af2ef0144e5ae4d0fbee57a6af8 virtualIDUuid=4424b77e00cb49bca232faf58e5d1f5e

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		3.6.0
virtualIDUuid			3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

BatchCreateIAM2VirtualIDFromConfigFile

Creates users in bulk by importing files. For example,

BatchCreateIAM2VirtualIDFromConfigFile virtualIDInfos=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=

Parameters

Name	Description	Optional	Starting Version
virtualIDInfos	The user information encoded in Base64 format.		3.6.0
resourceUuid		Yes	3.6.0
tagUuids	The tag UUID list.	Yes	3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

CheckIAM2VirtualIDConfigFile

Checks the user information imported from the files to determine whether uses can be created in bulk. For example,

CheckIAM2VirtualIDConfigFile virtualIDInfos=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=

Parameters

Name	Description	Optional	Starting Version
virtualIDInfos	The user information encoded in Base64 format.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

AttachIAM2ProjectToIAM2Organization

Attaches a project to an organization. For example,

AttachIAM2ProjectToIAM2Organization projectUuid=d5698b56f9f23a61958201cf7bee4e72 organizationUuid=72363068daea3772bb52aa663554c1e5

Parameters

Name	Description	Optional	Starting Version
projectUuid	The project UUID.		3.6.0
organizationUuid	The organization UUID.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

DetachIAM2ProjectFromIAM2Organization

Detaches a project from an organization. For example,

DetachIAM2ProjectFromIAM2Organization projectUuid=3fbdf0b46d3b3dec908ddb90fd4c6f42

Parameters

Name	Description	Optional	Starting Version
projectUuid	The project UUID.		3.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.6.0
timeout		Yes

QueryIAM2OrganizationProjectRef

Queries the reference between an organization and a project. For example,

QueryIAM2OrganizationProjectRef

Primitive Fields of Query

See IAM2 Organization and Project Reference Inventory.

QueryIAM2ProjectAccountRef

Queries the reference between a project and an account. For example,

QueryIAM2ProjectAccountRef

Primitive Fields of Query

See IAM2 Project and Account Reference Inventory.

GetIAM2OrganizationVirtualIDNumber

Retrieves the number of members in an organization. For example,

GetIAM2OrganizationVirtualIDNumber uuid=3fbdf0b46d3b3dec908ddb90fd4c6f42

Parameters

Name	Description	Optional	Starting Version
uuid	The UUID of the organization.		4.0.0
userTags	The user tags. For more information, seeCreateUserTag.	Yes	4.0.0
systemTags	The system tags. For more information, seeCreateSystemTag.	Yes	4.0.0
timeout		Yes

SetOrganizationOperation

Sets an operational admin, for example,

SetOrganizationOperation uuid=3fbdf0b46d3b3dec908ddb90f44c6f33 virtualIDUuid=3fbdf0b46d3b3dec908ddb90fd4c6f42

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		4.3.6
virtualIDUuid	The user UUID.		4.3.6
userTags	The user tags. For more information, seeCreateUserTag.	Yes	4.3.6
systemTags	The system tags. For more information, seeCreateSystemTag.	Yes	4.3.6
timeout		Yes

UpdateOrganizationQuota

Updates the quota of an organization.

UpdateOrganizationQuota identityUuid=3fbdf0b46d3b3dec908ddb90fd4c6f42 name=quota value=100.0

Parameters

Name	Description	Optional	Starting Version
identityUuid	uuid		4.3.6
name	The quota name.		4.3.6
value	The modified value.		4.3.6
userTags	The user tags. For more information, seeCreateUserTag.	Yes	4.3.6
systemTags	The system tags. For more information, seeCreateSystemTag.	Yes	4.3.6
timeout		Yes

GetOrganizationQuotaUsage

Obtains the quota of an organization.

GetOrganizationQuotaUsage uuid=3fbdf0b46d3b3dec908ddb90fd4c6f42

Parameters

Name	Description	Optional	Starting Version
uuid	The resource UUID.		4.3.6
userTags	The user tags. For more information, seeCreateUserTag.	Yes	4.3.6
systemTags	The system tags. For more information, seeCreateSystemTag.	Yes	4.3.6
timeout		Yes

PreviousOperations NextProject