Project

CreateIAM2Project

Creates a project. For example,
CreateIAM2Project name=cloud

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
attributes Yes 2.4.0
resourceUuid Yes 2.4.0
quota Yes 2.4.0
roleUuids Yes 2.4.0
resourceTemplates The resource template. Yes 4.4.0
organizationUuid The organization UUID. Yes 4.4.0
tagUuids The tag UUID. Yes 4.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

CreateIAM2ProjectFromTemplate

Creates a project. For example,
CreateIAM2ProjectFromTemplate name=Stack templateUuid=31bede78c8b748d1b2ac8ea058135bb4

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
templateUuid Yes 2.4.0
resourceUuid Yes 2.4.0
roleUuids Yes 2.4.0
organizationUuid The organization UUID. Yes 4.4.0
tagUuids The tag UUID. Yes 4.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

DeleteIAM2Project

Deletes a project. For example,
DeleteIAM2Project uuid=fffc7e1b2a983029833d1ab52bfa8187

Parameters

Name Description Optional Valid Value 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

QueryIAM2Project

Queries a project. For example,
QueryIAM2Project name=cloud

Primitive Fields of Query

See Project 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 members (users) that belong to the project. 2.4.0

UpdateIAM2Project

Updates a project. For example,
UpdateIAM2Project uuid=63f57ce8c8013d56ac4df307cfb1c648

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
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

LoginIAM2Project

Logs in to a project. For example,
LoginIAM2Project projectName=cloud

Parameters

Name Description Optional Valid Value Starting Version
projectName 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

SetIAM2ProjectLoginExpired

Sets limits on login to a project. For example,
SetIAM2ProjectLoginExpired uuid=0897b0890bef412ebff18b515282025d loginExpired="allow 0 6 12 ? * 1 to 0 6 18 ? * 1"

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.3.0
loginExpired The login expiration expression. 4.3.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.3.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.3.0
timeout Yes

RemoveIAM2ProjectLoginExpired

Removes a limit on logins to a project. For example,
RemoveIAM2ProjectLoginExpired uuid=0897b0890bef412ebff18b515282025d attributeUuid=fc0faa18dd03408fbc7aa94f46a96ad9

Parameters

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

ChangeIAM2ProjectState

Changes the state of a project. For example,
ChangeIAM2ProjectState uuid=13096969d0093f76802126ca15d9ac9c 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

RemoveIAM2VirtualIDsFromProject

Removes a member from a project. For example,
RemoveIAM2VirtualIDsFromProject projectUuid=bd9eaf0cc58e3ffb8792922633be41d6 virtualIDUuids=e1bc00e294e430069d37c620583ed9fd 

Parameters

Name Description Optional Valid Value Starting Version
projectUuid 2.4.0
virtualIDUuids 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

GetIAM2SystemAttributes

Obtains the system attributes. For example,
GetIAM2SystemAttributes

Parameters

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

AddAttributesToIAM2Project

Adds attributes to a project. For example,
AddAttributesToIAM2Project uuid=71c17463bb2434f28e4649d77cd12366 attributes='[{"name":"some-attribute-name","value":"attribute-value"}]'

Parameters

Name Description Optional Valid Value Starting Version
uuid 2.4.0
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

RemoveAttributesFromIAM2Project

Removes attributes from a project. For example,
RemoveAttributesFromIAM2Project uuid=71c17463bb2434f28e4649d77cd12366 attributeUuids=3212113e647a3c4d9e7d2dc87f607a45

Parameters

Name Description Optional Valid Value 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

CreateIAM2VirtualIDGroup

Creates a member group. For example,
CreateIAM2VirtualIDGroup name=IAM2VirtualIDGroup

Parameters

Name Description Optional Valid Value Starting Version
projectUuid Yes 4.0.0
name The resource name. 2.4.0
description The detailed description of the resource. Yes 2.4.0
attributes Yes 2.4.0
resourceUuid 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

DeleteIAM2VirtualIDGroup

Deletes a member group. For example,
DeleteIAM2VirtualIDGroup uuid=70844c49506031a69cb4a19a1478cddf

Parameters

Name Description Optional Valid Value 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

QueryIAM2VirtualIDGroup

Queries a member group. For example,
QueryIAM2VirtualIDGroup name=VirtualIDGroup

Primitive Fields of Query

See Virtual ID Group 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 members that belong to the group. 2.4.0
roles Role Inventory The permissions owned by the user as a member. 2.4.0

UpdateIAM2VirtualIDGroup

Updates a member group. For example,
UpdateIAM2VirtualIDGroup uuid=384bd47592273ddcb71039de694a37d3

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
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

ChangeIAM2VirtualIDGroupState

Changes the state of a member group. For example,
ChangeIAM2VirtualIDGroupState uuid=2da22aa4a4c840e2a0e5368427c7ab60 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 system 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

AddIAM2VirtualIDsToProject

Adds a member to a project. For example,
AddIAM2VirtualIDsToProject projectUuid=6552671ff11d301cb593ed46b6db53ed virtualIDUuids=70d6ff93ccec388d92cd5c2c96f9df0b

Parameters

Name Description Optional Valid Value Starting Version
projectUuid 2.4.0
virtualIDUuids 2.4.0
roleUuids 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

RemoveIAM2VirtualIDsFromProjects

Removes users from projects. For example,
RemoveIAM2VirtualIDsFromProjects projectUuids=6552671ff11d301cb593ed46b6db53ed virtualIDUuids=70d6ff93ccec388d92cd5c2c96f9df0b

Parameters

Name Description Optional Valid Value Starting Version
projectUuids The project UUIDs. 4.0.0
virtualIDUuids The user UUIDs. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

AddIAM2VirtualIDsToProjects

Add multiple users to multiple projects. For exmple,
AddIAM2VirtualIDsToProjects projectUuids=6552671ff11d301cb593ed46b6db53ed virtualIDUuids=70d6ff93ccec388d92cd5c2c96f9df0b

Parameters

Name Description Optional Valid Value Starting Version
projectUuids The project UUIDs. 4.0.0
virtualIDUuids The user UUIDs. 4.0.0
roleUuids The role UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

AddIAM2VirtualIDGroupToProjects

Add multiple member groups to multiple projects. For example,
AddIAM2VirtualIDGroupToProjects structs={projectUuid:'44c1f89e3ea84f22ad7f50bb4da7d045', groupUuids:'818a4b0c515b410f8cbd58cdc505b897', roleUuids:'952c1a4da12f4ed9a9e2df0328d1b213'}

Parameters

Name Description Optional Valid Value Starting Version
structs The entry about the project, role, and member group. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

RemoveIAM2VirtualIDGroupFromProjects

Removes member groups from projects. For example,
RemoveIAM2VirtualIDGroupFromProjects projectUuids=6552671ff11d301cb593ed46b6db53ed

Parameters

Name Description Optional Valid Value Starting Version
projectUuids The project UUIDs. Yes 4.0.0
groupUuids The member group UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

AddResourceToIAM2Project

Adds a resource to a project. For example,
AddResourceToIAM2Project projectUuid=7e89f250537f36818cd3d079f2730b2d resourceTemplates=["{"name": "sgName", "resourceType": "SecurityGroupVO"}"]

Parameters

Name Description Optional Valid Value Starting Version
projectUuid The project UUID. 4.4.0
resourceTemplates The resource template. 4.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.4.0
timeout Yes

AddIAM2VirtualIDsToGroup

Adds a member to a group. For example,
AddIAM2VirtualIDsToGroup virtualIDUuids=28e44658cba33e57b96da2c430cbbefe groupUuid=2a5a0fe00543339f8c424e069df8c956

Parameters

Name Description Optional Valid Value Starting Version
virtualIDUuids 2.4.0
groupUuid 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

RemoveIAM2VirtualIDsFromGroup

Removes a member from a group. For example,
RemoveIAM2VirtualIDsFromGroup virtualIDUuids=de445baef47130f68b3db86d7614151f groupUuid=7e89f250537f36818cd3d079f2730b2d

Parameters

Name Description Optional Valid Value Starting Version
virtualIDUuids 2.4.0
groupUuid 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

UpdateIAM2VirtualID

Updates permissions of a user. For example,
UpdateIAM2VirtualID uuid=b86c9016b4f24953a9edefb53ca0678c

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
password Yes 2.4.0
userTags The user tag. For more information, see CreateUserTag. Yes 2.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.4.0
timeout Yes

AddRolesToIAM2VirtualID

Adds permission to a member. For example,
AddRolesToIAM2VirtualID virtualIDUuid=8245aba180633254a5dfd76cbdd6f773 roleUuids=d1140b7d8ca03f7ba15ce467a9befec6

Parameters

Name Description Optional Valid Value Starting Version
virtualIDUuid 2.4.0
roleUuids 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

RemoveRolesFromIAM2VirtualID

Removes permission from a member. For example,
RemoveRolesFromIAM2VirtualID roleUuids=0c535557981832d2a8a9748c590e7222 virtualIDUuid=8ac88abb03b336c68d9a5facd7a0cd8d

Parameters

Name Description Optional Valid Value Starting Version
roleUuids 2.4.0
virtualIDUuid 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

AddRolesToIAM2VirtualIDGroup

Adds permission to a member group. For example,
AddRolesToIAM2VirtualIDGroup roleUuids=15258e508f6e39cabb2b68e5e8b1dc57 groupUuid=606625f400b739b99a78355a54175dc7

Parameters

Name Description Optional Valid Value Starting Version
roleUuids 2.4.0
groupUuid 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

RemoveRolesFromIAM2VirtualIDGroup

Removes permission from a member group. For example,
RemoveRolesFromIAM2VirtualIDGroup roleUuids=46c87204285e38428ddbf4c971df2907 groupUuid=a1a30de59ad4346d9660fa63ea326ee7

Parameters

Name Description Optional Valid Value Starting Version
roleUuids 2.4.0
groupUuid 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

AddAttributesToIAM2VirtualIDGroup

Adds attributes to a member group. For example,
AddAttributesToIAM2VirtualIDGroup uuid=b86c9016b4f24953a9edefb53ca0678c attributes='[{"name":"some-attribute-name","value":"attribute-value"}]'

Parameters

Name Description Optional Valid Value 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

RemoveAttributesFromIAM2VirtualIDGroup

Removes attributes from a member group. For example,
RemoveAttributesFromIAM2VirtualIDGroup  uuid=71c17463bb2434f28e4649d77cd12366 attributeUuids=3212113e647a3c4d9e7d2dc87f607a45

Parameters

Name Description Optional Valid Value 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

CreateRole

Creates a role. For example,
CreateRole name=role1

Parameters

Name Description Optional Optional Version Starting Version
name The resource name. 2.4.0
description The detailed description of the resource. Yes 2.4.0
statements Yes 2.4.0
policyUuids Yes 2.4.0
resourceUuid 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

DeleteRole

Deletes a role. For example,
DeleteRole uuid=b246c8a6bce34bd8b771838a8596adf1

Parameters

Name Description Optional Valid Value 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

QueryRole

Queries a role. For example,
QueryRole

Primitive Fields of Query

See Role Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
virtualIDGroups Virtual ID Group Inventory The member group associated with the role. 2.4.0
virtualIDs Virtual ID Inventory The members (users) that belong to the group. 2.4.0

UpdateRole

Updates a role. For example,
UpdateRole uuid=b6991548b90a42dc8b2a533a027aad9a name=testrole

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.4.0
name The resource name. 2.4.0
description The detailed description of the resource. Yes 2.4.0
statements The permission statements. Yes 2.4.0
policyUuids The permission policy UUID. 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

ChangeRoleState

Changes the state of a role. For example,
ChangeRoleState uuid=fd5a3c75d69e40de99f94bfa0af831e0 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

AttachPolicyToRole

Attaches a permission policy to a role. For example,
AttachPolicyToRole roleUuid=655590adb52c496b9a89e24e73d36189 policyUuid=ff5cb8effd1144c9858218d948afbb61

Parameters

Name Description Optional Valid Value Starting Version
roleUuid 2.4.0
policyUuid The permission policy 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

DetachPolicyFromRole

Detaches a permission policy from a role. For example,
DetachPolicyFromRole roleUuid=655590adb52c496b9a89e24e73d36189 policyUuid=ff5cb8effd1144c9858218d948afbb61

Parameters

Name Description Optional Valid Value Starting Version
roleUuid 2.4.0
policyUuid The permission policy 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

AddPolicyStatementsToRole

Adds policy statements to a role. For example,
AddPolicyStatementsToRole uuid=655590adb52c496b9a89e24e73d36189 statements='[{"name":"ipsec","effect":"Allow","actions":["org.zstack.header.vipQos.**"]}]'

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.4.0
statements 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

RemovePolicyStatementsFromRole

Removes policy statements from a role. For example,
RemovePolicyStatementsFromRole uuid=655590adb52c496b9a89e24e73d36189 policyStatementUuids='[{"name":"ipsec","effect":"Allow","actions":["org.zstack.header.vipQos.**"]}]'

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.4.0
policyStatementUuids 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

AttachRoleToAccount

Attaches a role to an account. For example,
AttachRoleToAccount roleUuid=655590adb52c496b9a89e24e73d36189 accountUuid=2533823b9a764cd89f141f7bbcb78430

Parameters

Name Description Optional Valid Value Starting Version
roleUuid 2.4.0
accountUuid The account 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

DetachRoleFromAccount

Detaches a role from an account. For example,
DetachRoleFromAccount roleUuid=655590adb52c496b9a89e24e73d36189 accountUuid=2533823b9a764cd89f141f7bbcb78430

Parameters

Name Description Optional Valid Value Starting Version
roleUuid 2.4.0
accountUuid The account 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

GetIAM2VirtualIDAPIPermission

Obtains an API permission of a user. For example,
GetIAM2VirtualIDAPIPermission 

Parameters

Name Description Optional Valid Value Starting Version
apisToCheck 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

LoginIAM2Platform

Log in to the platform by using a different role. For example,
LoginIAM2Platform

Parameters

Name Description Optional Valid Value Starting Version
clientInfo Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center