tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud OrganizationData Types
Data Types
Last updated: 2025-02-26 11:51:51
Data Types
Last updated: 2025-02-26 11:51:51

AuthRelationFile

Real-name mutual trust application proof file.

Used by actions: InviteOrganizationMember.

Name Type Required Description
Name String Yes File name.
Note: This field may return null, indicating that no valid values can be obtained.
Url String Yes File path.

Note: This field may return null, indicating that no valid values can be obtained.

GroupInfo

User group information.

Used by actions: CreateGroup, GetGroup, ListGroups, UpdateGroup.

Name Type Required Description
GroupName String No User group name.
Description String No User group description.
CreateTime String No Creation time of the user group.
GroupType String No User group type. Manual: manually created; Synchronized: externally imported.
UpdateTime String No Modification time of the user group.
GroupId String No User group ID.
MemberCount Integer No Number of group members.
IsSelected Boolean No If the input parameter FilterUsers is provided, return true when the user is in the user group; otherwise, return false.

GroupMembers

User information.

Used by actions: ListGroupMembers.

Name Type Required Description
UserName String No Queried username.
DisplayName String No Display name of the user.
Description String No User description.
Email String No Email address of the user, which must be unique within the directory.
UserStatus String No User status: Enabled, Disabled.
UserType String No User type. Manual: manually created; Synchronized: externally imported.
UserId String No User ID.
JoinTime String No Time when the user joins the user group.

IdentityPolicy

Organization identity policy

Used by actions: CreateOrganizationIdentity, ListOrganizationIdentity, UpdateOrganizationIdentity.

Name Type Required Description
PolicyId Integer No CAM preset policy ID, which is valid and required when PolicyType is a preset policy.
PolicyName String No CAM preset policy name, which is valid and required when PolicyType is a preset policy.
PolicyType Integer No Policy type. Valid values: 1 (custom policy), 2 (preset policy). The default is 2.
Note: This field may return null, indicating that no valid values can be obtained.
PolicyDocument String No Custom policy content, which follows the CAM policy syntax. It is valid and required when PolicyType is a custom policy.
Note: This field may return null, indicating that no valid values can be obtained.

JoinedGroups

User group joined by the user.

Used by actions: ListJoinedGroupsForUser.

Name Type Required Description
GroupName String No User group name.
Description String No User group description.
GroupId String No User group ID.
GroupType String No User group type. Valid values:

Manual: manually created.
Synchronized: externally synchronized.
JoinTime String No Time of joining the user group.

ManagerShareUnit

Details of my shared unit list

Used by actions: DescribeShareUnits.

Name Type Description
UnitId String Shared unit ID.
Name String Shared unit name.
Uin Integer Shared unit administrator UIN.
OwnerUin Integer Shared unit administrator OwnerUin.
Area String Shared unit region.
Description String Description.

Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.

Note: This field may return null, indicating that no valid values can be obtained.
ShareResourceNum Integer The number of resources in a shared unit.
Note: This field may return null, indicating that no valid values can be obtained.
ShareMemberNum Integer The number of members in a shared unit.
Note: This field may return null, indicating that no valid values can be obtained.
ShareScope Integer Sharing scope. Valid values: 1: Only sharing within a group organization is allowed; 2: Sharing with any account is allowed.
Note: This field may return null, indicating that no valid values can be obtained.

MemberIdentity

Member management identity

Used by actions: DescribeOrganizationMembers.

Name Type Description
IdentityId Integer Identity ID.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityAliasName String Identity name.
Note: This field may return null, indicating that no valid values can be obtained.

MemberMainInfo

Main member information.

Used by actions: ListOrgServiceAssignMember.

Name Type Description
MemberUin Integer Member UIN
Note: This field may return null, indicating that no valid values can be obtained.
MemberName String Member name j.
Note: This field may return null, indicating that no valid values can be obtained.

NodeMainInfo

Main department information.

Used by actions: ListOrgServiceAssignMember.

Name Type Description
NodeId Integer Department ID
Note: This field may return null, indicating that no valid values can be obtained.
NodeName String Department name.
Note: This field may return null, indicating that no valid values can be obtained.

OrgIdentity

Organization identity

Used by actions: ListOrganizationIdentity.

Name Type Description
IdentityId Integer Identity ID.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityAliasName String Identity name.
Note: This field may return null, indicating that no valid values can be obtained.
Description String Description.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityPolicy Array of IdentityPolicy Identity policy.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityType Integer Identity type. Valid values: 1 (preset); 2 (custom).
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time.
Note: This field may return null, indicating that no valid values can be obtained.

OrgMember

Organization member

Used by actions: DescribeOrganizationMembers.

Name Type Description
MemberUin Integer Member UIN
Note: This field may return null, indicating that no valid values can be obtained.
Name String Member name
Note: This field may return null, indicating that no valid values can be obtained.
MemberType String Member type. Valid values: Invite (invited); Create (created).
Note: This field may return null, indicating that no valid values can be obtained.
OrgPolicyType String Relationship policy type
Note: This field may return null, indicating that no valid values can be obtained.
OrgPolicyName String Relationship policy name
Note: This field may return null, indicating that no valid values can be obtained.
OrgPermission Array of OrgPermission Relationship policy permission
Note: This field may return null, indicating that no valid values can be obtained.
NodeId Integer Node ID
Note: This field may return null, indicating that no valid values can be obtained.
NodeName String Node name
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.
IsAllowQuit String Whether the member is allowed to leave. Valid values: Allow, Denied.
Note: This field may return null, indicating that no valid values can be obtained.
PayUin String Payer UIN
Note: This field may return null, indicating that no valid values can be obtained.
PayName String Payer name
Note: This field may return null, indicating that no valid values can be obtained.
OrgIdentity Array of MemberIdentity Management identity
Note: This field may return null, indicating that no valid values can be obtained.
BindStatus String Security information binding status. Valid values: Unbound, Valid, Success, Failed.
Note: This field may return null, indicating that no valid values can be obtained.
PermissionStatus String Member permission status. Valid values: Confirmed, UnConfirmed.
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Member tag list.
Note: This field may return null, indicating that no valid values can be obtained.

OrgMemberAuthAccount

Authorization relationship between the member and sub-account

Used by actions: DescribeOrganizationMemberAuthAccounts.

Name Type Description
OrgSubAccountUin Integer Organization sub-account UIN.
Note: This field may return null, indicating that no valid values can be obtained.
PolicyId Integer Policy ID.
Note: This field may return null, indicating that no valid values can be obtained.
PolicyName String Policy name.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityId Integer Identity ID.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleName String Identity role name.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleAliasName String Identity role alias.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
OrgSubAccountName String Sub-account name
Note: This field may return null, indicating that no valid values can be obtained.

OrgMemberAuthIdentity

Authorizable identity of the organization member

Used by actions: DescribeOrganizationMemberAuthIdentities.

Name Type Description
IdentityId Integer Identity ID.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleName String Role name of an identity
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleAliasName String Role alias of an identity
Note: This field may return null, indicating that no valid values can be obtained.
Description String Identity description.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Time of initial configuration success.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Time of last configuration success.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityType Integer Identity type. Valid values: 1 (preset identity), 2 (custom identity).
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Configuration status. Valid values: 1 (configuration completed), 2 (reconfiguration required).
Note: This field may return null, indicating that no valid values can be obtained.
MemberUin Integer Member Uin.
Note: This field may return null, indicating that no valid values can be obtained.
MemberName String Member name.
Note: This field may return null, indicating that no valid values can be obtained.

OrgMemberPolicy

Authorized policy of the organization member

Used by actions: DescribeOrganizationMemberPolicies.

Name Type Description
PolicyId Integer Policy ID.
Note: This field may return null, indicating that no valid values can be obtained.
PolicyName String Policy name.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityId Integer Identity ID.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleName String Identity role name.
Note: This field may return null, indicating that no valid values can be obtained.
IdentityRoleAliasName String Identity role alias.
Note: This field may return null, indicating that no valid values can be obtained.
Description String Description.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time.
Note: This field may return null, indicating that no valid values can be obtained.

OrgNode

Department

Used by actions: DescribeOrganizationNodes.

Name Type Description
NodeId Integer Organization node ID
Note: This field may return null, indicating that no valid values can be obtained.
Name String Name
Note: This field may return null, indicating that no valid values can be obtained.
ParentNodeId Integer Parent node ID
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Member tag list.
Note: This field may return null, indicating that no valid values can be obtained.

OrgPermission

Relationship policy permission

Used by actions: DescribeOrganization, DescribeOrganizationMembers.

Name Type Description
Id Integer Permission ID
Name String Permission name

OrganizationServiceAssign

Organization service settings.

Used by actions: ListOrganizationService.

Name Type Description
ServiceId Integer Organization service ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProductName String Organization service product name.
Note: This field may return null, indicating that no valid values can be obtained.
IsAssign Integer Whether to support delegation. Valid values: 1 (yes), 2 (no).
Note: This field may return null, indicating that no valid values can be obtained.
Description String Organization service description.
Note: This field may return null, indicating that no valid values can be obtained.
MemberNum String Number of the current delegated admins.
Note: This field may return null, indicating that no valid values can be obtained.
Document String Help documentation.
Note: This field may return null, indicating that no valid values can be obtained.
ConsoleUrl String Console path of the organization service product.
Note: This field may return null, indicating that no valid values can be obtained.
IsUsageStatus Integer Whether to access the usage status. Valid values: 1 (yes),
2 (no).
Note: This field may return null, indicating that no valid values can be obtained.
CanAssignCount Integer Limit for the number of delegated admins.
Note: This field may return null, indicating that no valid values can be obtained.
Product String Organization service product identifier.
Note: This field may return null, indicating that no valid values can be obtained.
ServiceGrant Integer Whether to support organization service authorization. Valid values: 1 (yes), 2 (no).
Note: This field may return null, indicating that no valid values can be obtained.
GrantStatus String Enabling status of organization service authorization. This field is valid when ServiceGrant is 1. Valid values: Enabled, Disabled.
Note: This field may return null, indicating that no valid values can be obtained.
IsSetManagementScope Integer Whether to support setting the delegated management scope. Valid values: 1 (yes), 2 (no).
Note: This field may return null, indicating that no valid values can be obtained.

OrganizationServiceAssignMember

Information on the delegated member of the organization service.

Used by actions: ListOrgServiceAssignMember.

Name Type Description
ServiceId Integer Organization service ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProductName String Organization service product name.
Note: This field may return null, indicating that no valid values can be obtained.
MemberUin Integer Uin of the delegated admin.
Note: This field may return null, indicating that no valid values can be obtained.
MemberName String Name of the delegated admin.
Note: This field may return null, indicating that no valid values can be obtained.
UsageStatus Integer Activation status. Valid values: 0 (the service has no activation status), 1 (activated), 2 (not activated).
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Delegation time.
Note: This field may return null, indicating that no valid values can be obtained.
ManagementScope Integer Management scope of the delegated admin. Valid values: 1 (all members), 2 (partial members).
Note: This field may return null, indicating that no valid values can be obtained.
ManagementScopeMembers Array of MemberMainInfo Uin list of managed members. This parameter is valid when ManagementScope is 2.
Note: This field may return null, indicating that no valid values can be obtained.
ManagementScopeNodes Array of NodeMainInfo ID list of the managed departments. This parameter is valid when ManagementScope is 2.
Note: This field may return null, indicating that no valid values can be obtained.

PolicyDetail

Policy details.

Used by actions: AddPermissionPolicyToRoleConfiguration.

Name Type Required Description
PolicyId Integer Yes Policy ID.
PolicyName String No Policy name.
Note: This field may return null, indicating that no valid values can be obtained.

ProductResource

Product resources

Used by actions: AddShareUnitResources.

Name Type Required Description
ProductResourceId String Yes Product resource ID.

RoleAssignmentInfo

Authorized member account information.

Used by actions: CreateRoleAssignment.

Name Type Required Description
PrincipalId String No Identity ID for the CAM user synchronization. Valid values:
When the PrincipalType value is Group, it is the CIC user group ID (g-).
When the PrincipalType value is User, it is the CIC user ID (u-).
PrincipalType String No Identity type for the CAM user synchronization. Valid values:

User: indicates that the identity for the CAM user synchronization is a CIC user.
Group: indicates that the identity for the CAM user synchronization is a CIC user group.
TargetUin Integer No UIN of the synchronized target account of the Tencent Cloud Organization.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.
RoleConfigurationId String No Permission configuration ID.

RoleAssignments

Authorization details of the member account.

Used by actions: ListRoleAssignments.

Name Type Required Description
RoleConfigurationId String No Permission configuration ID.
RoleConfigurationName String No Permission configuration name.
TargetUin Integer No UIN of the target account of the Tencent Cloud Organization.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.
PrincipalId String No Identity ID for the CAM user synchronization. Valid values: When the PrincipalType value is Group, it is the CIC user group ID (g-). When the PrincipalType value is User, it is the CIC user ID (u-).
PrincipalType String No Identity type for the CAM user synchronization. Valid values: User: indicates that the identity for the CAM user synchronization is a CIC user; Group: indicates that the identity for the CAM user synchronization is a CIC user group.
PrincipalName String No User name or user group name.
CreateTime String No Creation time.
UpdateTime String No Update time.
TargetName String No Name of the target account of the Tencent Cloud Organization.

RoleConfiguration

CIC permission configuration.

Used by actions: CreateRoleConfiguration, GetRoleConfiguration, ListRoleConfigurations, UpdateRoleConfiguration.

Name Type Required Description
RoleConfigurationId String No Permission configuration ID.
RoleConfigurationName String No Permission configuration name.
Description String No Permission configuration description.
SessionDuration Integer No Session duration. It indicates the maximum session duration when CIC users use the access configuration to access member accounts.
Unit: seconds.
RelayState String No Initial access page. It indicates the initial access page URL when CIC users use the access configuration to access member accounts.
CreateTime String No Creation time of the permission configuration.
UpdateTime String No Update time of the permission configuration.
IsSelected Boolean No If the input parameter FilterTargets is provided, check whether the member account has been configured with permissions. If configured, return true; otherwise, return false.

RoleConfigurationProvisionings

Permission configuration synchronization.

Used by actions: ListRoleConfigurationProvisionings.

Name Type Required Description
DeploymentStatus String No Deployed: Deployment succeeded; DeployedRequired: Redeployment required; DeployFailed: Deployment failed.
RoleConfigurationId String No Permission configuration ID.
RoleConfigurationName String No Permission configuration name.
TargetUin Integer No UIN of the target account of the Tencent Cloud Organization.
TargetName String No Name of the target account of the Tencent Cloud Organization.
CreateTime String No Creation time.
UpdateTime String No Modification time.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.

RolePolicie

CIC permission policy.

Used by actions: ListPermissionPoliciesInRoleConfiguration.

Name Type Required Description
RolePolicyId Integer No Policy ID.
Note: This field may return null, indicating that no valid values can be obtained.
RolePolicyName String No Permission policy name.
RolePolicyType String No Permission policy type.
RolePolicyDocument String No Custom policy content. This parameter is only returned for custom policies.
AddTime String No The time when the permission policy is added to the permission configuration.

RoleProvisioningsTask

Status information of the role synchronization task.

Used by actions: DismantleRoleConfiguration, ProvisionRoleConfiguration.

Name Type Required Description
TaskId String No Task ID.
RoleConfigurationId String No Permission configuration ID.
RoleConfigurationName String No Permission configuration name.
TargetUin Integer No UIN of the authorized target account of the Tencent Cloud Organization.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.
Note: This field may return null, indicating that no valid values can be obtained.
TaskType String No Task type.
Note: This field may return null, indicating that no valid values can be obtained.
TaskStatus String No Task status. InProgress: The task is in progress; Failed: The task failed; Success: The task succeeded.
Note: This field may return null, indicating that no valid values can be obtained.

SAMLIdPCertificate

SAML signing certificate information.

Used by actions: ListExternalSAMLIdPCertificates.

Name Type Required Description
SerialNumber String No Certificate serial number.
Issuer String No Certificate issuer.
Version Integer No Certificate version.
CertificateId String No Certificate ID.
PublicKey String No Public key certificate in PEM format (Base64 encoded).
SignatureAlgorithm String No Signature algorithm of the certificate.
NotAfter String No Expiration time of the certificate.
NotBefore String No Creation time of the certificate.
Subject String No Certificate subject.
X509Certificate String No X509 certificate in PEM format.

SAMLIdentityProviderConfiguration

SAML identity provider configuration information.

Used by actions: GetExternalSAMLIdentityProvider.

Name Type Required Description
EntityId String No IdP identifier.
SSOStatus String No SSO enabling status. Valid values: Enabled, Disabled (default).
EncodedMetadataDocument String No IdP metadata document (Base64 encoded).
CertificateIds Array of String No X509 certificate ID.
LoginUrl String No IdP login URL.
CreateTime String No Creation time.
UpdateTime String No Update time.

SAMLServiceProvider

SAML service provider information.

Used by actions: GetZoneSAMLServiceProviderInfo.

Name Type Required Description
EntityId String No https://tencentcloudsso.com/saml/sp/z-sjw8ensa**
ZoneId String No Space ID.
EncodedMetadataDocument String No SP metadata document (Base64 encoded).
AcsUrl String No SP ACS URL.

SCIMCredential

SCIM key.

Used by actions: ListSCIMCredentials.

Name Type Description
ZoneId String Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters.
Status String SCIM key status. Enabled: enabled. Disabled: disabled.
CredentialId String SCIM key ID, which starts with the scimcred- prefix, followed by 12 random digits/lowercase letters.
CredentialType String SCIM key type.
CreateTime String Creation time of a SCIM key.
ExpireTime String Expiration time of a SCIM key.

ShareArea

Shared region

Used by actions: DescribeShareAreas.

Name Type Description
Name String Region name.
Area String Region identifier.
AreaId Integer Region ID.

ShareMember

Shared member information

Used by actions: AddShareUnitMembers, DeleteShareUnitMembers.

Name Type Required Description
ShareMemberUin Integer Yes Shared member UIN.

ShareResource

Shared resources

Used by actions: DeleteShareUnitResources.

Name Type Required Description
ProductResourceId String No Product resource ID.
Note: This field may return null, indicating that no valid values can be obtained.

ShareUnitMember

Shared unit members

Used by actions: DescribeShareUnitMembers.

Name Type Description
ShareMemberUin Integer Shared member UIN.
CreateTime String Creation time.

Note: This field may return null, indicating that no valid values can be obtained.

ShareUnitResource

Shared unit resources

Used by actions: DescribeShareUnitResources.

Name Type Description
ResourceId String Shared resource ID.
Type String Shared resource type.
CreateTime String Creation time.

Note: This field may return null, indicating that no valid values can be obtained.
ProductResourceId String Product resource ID.
SharedMemberNum Integer The number of members in a shared unit.
Note: This field may return null, indicating that no valid values can be obtained.
SharedMemberUseNum Integer The number of shared unit members in use.
Note: This field may return null, indicating that no valid values can be obtained.
ShareManagerUin Integer Shared administrator OwnerUin.
Note: This field may return null, indicating that no valid values can be obtained.

Tag

Tag key-value pair.

Used by actions: AddOrganizationNode, CreateOrganizationMember, DescribeOrganizationMembers, DescribeOrganizationNodes, InviteOrganizationMember.

Name Type Required Description
TagKey String Yes Tag key

Note: This field may return null, indicating that no valid values can be obtained.
TagValue String Yes Tag value

Note: This field may return null, indicating that no valid values can be obtained.

TaskInfo

Task status information.

Used by actions: CreateRoleAssignment, DeleteRoleAssignment, ListTasks.

Name Type Required Description
TaskId String No Task ID.
RoleConfigurationId String No Permission configuration ID.
RoleConfigurationName String No Permission configuration name.
TargetUin Integer No UIN of the authorized target member account.
TargetType String No Type of the synchronized target account. ManagerUin: admin account; MemberUin: member account.
PrincipalId String No Identity ID for the user authorization. If the identity type is CIC user, it is the user ID; if the identity type is user group, it is the user group ID.
PrincipalType String No Identity type for the user authorization. User: CIC user; Group: CIC user group.
TaskType String No Task type.
Status String No InProgress: The task is being executed; Success: The task execution succeeded; Failed: The task execution failed.
FailureReason String No Cause of the failure.
Note: This field may return null, indicating that no valid values can be obtained.

TaskStatus

Task status information.

Used by actions: GetProvisioningTaskStatus, GetTaskStatus.

Name Type Required Description
Status String No Task status. Valid values: InProgress: The task is being executed; Success: The task execution succeeded; Failed: The task execution failed.
TaskId String No Task ID.
TaskType String No Task type. Valid values:ProvisionRoleConfiguration: Deploy permission configurations.
DeprovisionRoleConfiguration: Undeploy permission configurations.CreateRoleAssignment: Grant authorizations on member accounts.
DeleteRoleAssignment: Remove authorizations on member accounts.
FailureReason String No Cause of task failure.
Description.
This parameter is displayed only when the Status is Failed.

UserInfo

User information.

Used by actions: CreateUser, GetUser, ListUsers, UpdateUser.

Name Type Required Description
UserName String No Queried username.
FirstName String No First name of the user.
LastName String No Last name of the user.
DisplayName String No Display name of the user.
Description String No User description.
Email String No Email address of the user, which must be unique within the directory.
UserStatus String No User status. Valid values: Enabled, Disabled.
UserType String No User type. Manual: manually created; Synchronized: externally imported.
UserId String No User ID.
CreateTime String No Creation time of the user.
UpdateTime String No Modification time of the user.
IsSelected Boolean No Whether selected

UserProvisioning

User synchronization information.

Used by actions: GetUserSyncProvisioning, ListUserSyncProvisionings.

Name Type Required Description
UserProvisioningId String No CAM user synchronization status. Valid values:

Enabled: CAM user synchronization is enabled.
Disabled: CAM user synchronization is disabled.
Description String No Description.
Status String No CAM user synchronization status. Valid values:

Enabled: CAM user synchronization is enabled.
Disabled: CAM user synchronization is disabled.
PrincipalId String No Identity ID for the CAM user synchronization. Valid values:
When the PrincipalType value is Group, it is the CIC user group ID (g-).
When the PrincipalType value is User, it is the CIC user ID (u-).
PrincipalName String No Identity name for the CAM user synchronization. Valid values:When the PrincipalType value is Group, it is the CIC user group name.
When the PrincipalType value is User, it is the CIC user name.
PrincipalType String No Identity type for the CAM user synchronization. Valid values:

User: indicates that the identity for the CAM user synchronization is a CIC user.
Group: indicates that the identity for the CAM user synchronization is a CIC user group.
TargetUin Integer No UIN of the target account of the Tencent Cloud Organization.
TargetName String No Name of the target account of the Tencent Cloud Organization.
DuplicationStrategy String No Conflict policy. It indicates the handling policy for existence of a user with the same username when CIC users are synchronized to CAM. Valid values: KeepBoth: Keep both, that is, add the _cic suffix to the CIC user's username and then try to create a CAM user with the username when CIC users are synchronized to CAM and a user with the same username already exists in CAM; TakeOver: Replace, that is, directly replace the existing CAM user with the synchronized CIC user when CIC users are synchronized to CAM and a user with the same username already exists in CAM.
DeletionStrategy String No Deletion policy. It indicates the handling policy for CAM users already synchronized when the CAM user synchronization is deleted. Valid values: Delete: Delete the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted; Keep: Keep the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted.
CreateTime String No Creation time.
UpdateTime String No Update time.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.

UserProvisioningsTask

Status information of the user synchronization task.

Used by actions: CreateUserSyncProvisioning, DeleteUserSyncProvisioning.

Name Type Required Description
TaskId String No Task ID.
TargetUin Integer No UIN of the authorized target account of the Tencent Cloud Organization.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.
TaskType String No Task type. StartProvisioning: Start the user synchronization; DeleteProvisioning: Delete the user synchronization.
TaskStatus String No Task status. InProgress: The task is in progress; Failed: The task failed; Success: The task succeeded.
UserProvisioningId String No User synchronization ID.
PrincipalId String No Identity ID for the CAM user synchronization. Valid values: When the PrincipalType value is Group, it is the CIC user group ID (g-). When the PrincipalType value is User, it is the CIC user ID (u-).
PrincipalType String No Identity type for the CAM user synchronization. Valid values: User: indicates that the identity for the CAM user synchronization is a CIC user; Group: indicates that the identity for the CAM user synchronization is a CIC user group.
PrincipalName String No User name or user group name.
DuplicationStrategy String No Conflict policy. KeepBoth: Keep both; TakeOver: Replace.
DeletionStrategy String No Deletion policy: Delete, Keep.

UserSyncProvisioning

CAM user synchronization information.

Used by actions: CreateUserSyncProvisioning.

Name Type Required Description
Description String No Description.
PrincipalId String No Identity ID for the CAM user synchronization. Valid values:
When the PrincipalType value is Group, it is the CIC user group ID (g-).
When the PrincipalType value is User, it is the CIC user ID (u-).
PrincipalType String No Identity type for the CAM user synchronization. Valid values:

User: indicates that the identity for the CAM user synchronization is a CIC user.
Group: indicates that the identity for the CAM user synchronization is a CIC user group.
TargetUin Integer No UIN of the synchronized target account of the Tencent Cloud Organization.
DuplicationStrategy String No Conflict policy. It indicates the handling policy for existence of a user with the same username when CIC users are synchronized to CAM. Valid values: KeepBoth: Keep both, that is, add the _cic suffix to the CIC user's username and then try to create a CAM user with the username when CIC users are synchronized to CAM and a user with the same username already exists in CAM; TakeOver: Replace, that is, directly replace the existing CAM user with the synchronized CIC user when CIC users are synchronized to CAM and a user with the same username already exists in CAM.
DeletionStrategy String No Deletion policy. It indicates the handling policy for CAM users already synchronized when the CAM user synchronization is deleted. Valid values: Delete: Delete the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted; Keep: Keep the CAM users already synchronized from CIC to CAM when the CAM user synchronization is deleted.
TargetType String No Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.

ZoneStatistics

CIC space statistics.

Used by actions: GetZoneStatistics.

Name Type Required Description
UserQuota Integer No User quota.
GroupQuota Integer No User group quota.
RoleConfigurationQuota Integer No Permission configuration quota.
SystemPolicyPerRoleConfigurationQuota Integer No System policy quota bound to the permission configuration.
UserCount Integer No Number of users.
GroupCount Integer No Number of user groups.
RoleConfigurationCount Integer No Number of permission configurations.
UserProvisioningCount Integer No Number of synchronized users.
RoleConfigurationSyncCount Integer No Number of synchronized roles.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support