产品概述
相关概念
Real-name mutual trust application proof file.
Used by actions: InviteOrganizationMember.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | File name. |
| Url | String | Yes | File path. |
Valid policy.
Used by actions: DescribeEffectivePolicy.
| Name | Type | Description |
|---|---|---|
| TargetId | Integer | Target ID. |
| PolicyContent | String | Effective policy content. |
| LastUpdatedTimestamp | Integer | Effective policy update time. |
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. |
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. |
| 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. |
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 value is 2. |
| PolicyDocument | String | No | Custom policy content, which follows the CAM policy syntax. It is valid and mandatory when PolicyType is a custom policy. |
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. |
Queries the list of SCPs associated with the target.
Used by actions: ListPoliciesForTarget.
| Name | Type | Description |
|---|---|---|
| StrategyId | Integer | Policy ID |
| StrategyName | String | Policy name. |
| Remark | String | Remarks |
| Uin | Integer | Associated account or node. |
| Type | Integer | Association type. 1: node association; 2: user association. |
| AddTime | String | Policy creation time. |
| UpdateTime | String | Policy update time. |
| Name | String | Department name. |
| AttachTime | String | Policy binding time. |
Queries the list of targets associated with a specified SCP.
Used by actions: ListTargetsForPolicy.
| Name | Type | Description |
|---|---|---|
| Uin | Integer | SCP account UIN or node ID. |
| RelatedType | Integer | Association type. 1: node association; 2: user association. |
| Name | String | Account or node name. |
| AddTime | String | Binding time. |
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. . |
| CreateTime | String | Creation time. . |
| ShareResourceNum | Integer | The number of resources in a shared unit. . |
| ShareMemberNum | Integer | The number of members in a shared unit. . |
| ShareScope | Integer | Sharing scope. valid values: 1: only sharing within a group organization is allowed; 2: sharing with any account is allowed. . |
| ShareNodeNum | Integer | The number of departments in a shared unit. . |
Member management identity
Used by actions: DescribeOrganizationMembers.
| Name | Type | Description |
|---|---|---|
| IdentityId | Integer | Identity ID. |
| IdentityAliasName | String | Identity name. |
Main member information.
Used by actions: DescribeOrganizationMembersAuthPolicy, ListOrgServiceAssignMember.
| Name | Type | Description |
|---|---|---|
| MemberUin | Integer | Member UIN |
| MemberName | String | Member name. |
Main department information.
Used by actions: ListOrgServiceAssignMember.
| Name | Type | Description |
|---|---|---|
| NodeId | Integer | Department ID |
| NodeName | String | Department name. |
Organization identity
Used by actions: ListOrganizationIdentity.
| Name | Type | Description |
|---|---|---|
| IdentityId | Integer | Identity ID. |
| IdentityAliasName | String | Identity name. |
| Description | String | Description. |
| IdentityPolicy | Array of IdentityPolicy | Identity policy. |
| IdentityType | Integer | Identity type. 1: preset; 2: custom. |
| UpdateTime | String | Update time. |
Organization member
Used by actions: DescribeOrganizationMembers.
| Name | Type | Description |
|---|---|---|
| MemberUin | Integer | Member UIN. |
| Name | String | Member name. |
| MemberType | String | Member type. Invite: invited, Create: created. |
| OrgPolicyType | String | Relationship policy type. |
| OrgPolicyName | String | Relational policy name. |
| OrgPermission | Array of OrgPermission | Relationship policy permission. |
| NodeId | Integer | Node ID. |
| NodeName | String | Node name. |
| Remark | String | Remarks |
| CreateTime | String | Creation time |
| UpdateTime | String | Update date |
| IsAllowQuit | String | Whether to allow a member to exit. Valid values: Allow, Denied. |
| PayUin | String | Proxy payer UIN. |
| PayName | String | Proxy payer name. |
| OrgIdentity | Array of MemberIdentity | Admin identity. |
| BindStatus | String | Security information binding status Unbound: Unbound, to be activated: Valid, binding succeeded: Success, binding Failed: Failed. |
| PermissionStatus | String | Member's permission status. Valid values: Confirmed, UnConfirmed. |
| Tags | Array of Tag | Member tag list. |
| NickName | String | Tencent cloud nickname. |
Authorization relationship between the member and sub-account
Used by actions: DescribeOrganizationMemberAuthAccounts.
| Name | Type | Description |
|---|---|---|
| OrgSubAccountUin | Integer | Organization sub-account Uin. |
| PolicyId | Integer | Policy ID. |
| PolicyName | String | Policy name. |
| IdentityId | Integer | Identity ID. |
| IdentityRoleName | String | Identity role name. |
| IdentityRoleAliasName | String | Role alias of an identity. |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time. |
| OrgSubAccountName | String | Sub-Account. |
Authorizable identity of the organization member
Used by actions: DescribeOrganizationMemberAuthIdentities.
| Name | Type | Description |
|---|---|---|
| IdentityId | Integer | Identity ID. |
| IdentityRoleName | String | Role name of an identity. |
| IdentityRoleAliasName | String | Role alias of an identity. |
| Description | String | Identity description. |
| CreateTime | String | Time of initial configuration success. |
| UpdateTime | String | Time of the last successful configuration. |
| IdentityType | Integer | Identity type. Valid values: 1: preset identity; 2: custom identity. |
| Status | Integer | Configuration status. Valid values: 1: configuration completed; 2: reconfiguration required. |
| MemberUin | Integer | Member UIN. |
| MemberName | String | Member name. |
Authorized policy of the organization member
Used by actions: DescribeOrganizationMemberPolicies.
| Name | Type | Description |
|---|---|---|
| PolicyId | Integer | Policy ID. |
| PolicyName | String | Policy name. |
| IdentityId | Integer | Identity ID. |
| IdentityRoleName | String | Identity role name. |
| IdentityRoleAliasName | String | Role alias of an identity. |
| Description | String | Description. |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time. |
Organization member access authorization policy.
Used by actions: DescribeOrganizationMembersAuthPolicy.
| 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. |
| CreateTime | String | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| PolicyId | Integer | Member access policy ID. Note: This field may return null, indicating that no valid values can be obtained. |
| PolicyName | String | Member access policy name. 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. |
| OrgSubAccountUin | Integer | Sub-account UIN or user group ID. Note: This field may return null, indicating that no valid values can be obtained. |
| OrgSubAccountName | String | Sub-account name or user group name. Note: This field may return null, indicating that no valid values can be obtained. |
| BindType | Integer | Binding type. 1: sub-account; 2: user group. Note: This field may return null, indicating that no valid values can be obtained. |
| Members | Array of MemberMainInfo | Member information. Note: This field may return null, indicating that no valid values can be obtained. |
Department
Used by actions: DescribeOrganizationNodes.
| Name | Type | Description |
|---|---|---|
| NodeId | Integer | Organization node ID. |
| Name | String | Name |
| ParentNodeId | Integer | Parent Node ID |
| Remark | String | Remarks |
| CreateTime | String | Creation time |
| UpdateTime | String | Update date |
| Tags | Array of Tag | Member tag list. |
Relationship policy permission
Used by actions: DescribeOrganization, DescribeOrganizationMembers.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Permission ID |
| Name | String | Permission name |
Organization service settings.
Used by actions: ListOrganizationService.
| Name | Type | Description |
|---|---|---|
| ServiceId | Integer | Organization service ID. |
| ProductName | String | Organization service product name. |
| IsAssign | Integer | Specifies whether delegation is supported. Valid values: 1: yes; 2: no. |
| Description | String | Organization service description. |
| MemberNum | String | Number of delegated administrators. |
| Document | String | Help documentation. |
| ConsoleUrl | String | Path to the console for organization service products. |
| IsUsageStatus | Integer | Whether to access the usage status. valid values: 1 (yes). 2: no. |
| CanAssignCount | Integer | Limit on the number of delegated administrators. |
| Product | String | Organization service product ID. |
| ServiceGrant | Integer | Specifies whether organization service authorization is supported. Valid values: 1: yes; 2: no. |
| GrantStatus | String | Specifies whether organization services are authorized. This field is valid when the value of ServiceGrant is 1. Valid values: Enabled: authorized; Disabled: not authorized. |
| IsSetManagementScope | Integer | Specifies whether the scope of delegated management can be set. Valid values: 1: yes; 2 no. |
Information on the delegated member of the organization service.
Used by actions: ListOrgServiceAssignMember.
| Name | Type | Description |
|---|---|---|
| ServiceId | Integer | Organization service ID. |
| ProductName | String | Organization service product name. |
| MemberUin | Integer | Uin of the delegated admin. |
| MemberName | String | Delegated administrator name. |
| UsageStatus | Integer | Activation status. Valid values: 0: not applicable to the service; 1: activated; 2: not activated. |
| CreateTime | String | Delegation time. |
| ManagementScope | Integer | Management scope of the delegated administrator. Valid values: 1: all members; 2 some members. |
| ManagementScopeMembers | Array of MemberMainInfo | UIN list of the managed members. This parameter is valid when the value of ManagementScope is 2. |
| ManagementScopeNodes | Array of NodeMainInfo | ID list of the departments under management. This parameter is valid when the value of ManagementScope is 2. |
Policy details.
Used by actions: AddPermissionPolicyToRoleConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| PolicyId | Integer | Yes | Policy ID. |
| PolicyName | String | No | Policy name. |
Product resources
Used by actions: AddShareUnitResources.
| Name | Type | Required | Description |
|---|---|---|---|
| ProductResourceId | String | Yes | Product resource ID. |
Resources and associated Tags.
Used by actions: ListNonCompliantResource.
| Name | Type | Description |
|---|---|---|
| Resource | String | Six-Segment resource format. tencent cloud uses the six-segment resource format to describe a resource. For example: qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}. |
| ComplianceDetails | TagComplianceDetails | Compliance details. |
| Tags | Array of Tags | Resource tag. |
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. |
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. |
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. |
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. |
CIC permission policy.
Used by actions: ListPermissionPoliciesInRoleConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| RolePolicyId | Integer | No | Policy ID. |
| 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. |
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. |
| TaskType | String | No | Task type. |
| TaskStatus | String | No | Task status. InProgress: The task is in progress; Failed: The task failed; Success: The task succeeded. |
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. |
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. |
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. |
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. |
Shared region
Used by actions: DescribeShareAreas.
| Name | Type | Description |
|---|---|---|
| Name | String | Region name. |
| Area | String | Region identifier. |
| AreaId | Integer | Region ID. |
Shared member information
Used by actions: AddShareUnitMembers, DeleteShareUnitMembers.
| Name | Type | Required | Description |
|---|---|---|---|
| ShareMemberUin | Integer | Yes | Shared member UIN. |
Shared resources
Used by actions: DeleteShareUnitResources.
| Name | Type | Required | Description |
|---|---|---|---|
| ProductResourceId | String | No | Product resource ID. |
Resources shared with me.
Used by actions: DescribeResourceToShareMember.
| Name | Type | Description |
|---|---|---|
| ResourceId | String | Shared unit resource ID. |
| Type | String | Resource type. |
| UnitId | String | Shared unit ID. |
| UnitName | String | Shared unit name. |
| CreateTime | String | Creation time. |
| ProductResourceId | String | Business resource ID. |
| ShareManagerUin | Integer | Shared account Uin. |
Shared unit members
Used by actions: DescribeShareUnitMembers.
| Name | Type | Description |
|---|---|---|
| ShareMemberUin | Integer | Shared member UIN. |
| CreateTime | String | Creation time. |
Department in the shared unit.
Used by actions: DescribeShareUnitNodes.
| Name | Type | Description |
|---|---|---|
| ShareNodeId | Integer | Shared department ID. . |
| CreateTime | String | Creation time. . |
Shared unit resources
Used by actions: DescribeShareUnitResources.
| Name | Type | Description |
|---|---|---|
| ResourceId | String | Shared resource ID. |
| Type | String | Shared resource type. |
| CreateTime | String | Creation time. |
| ProductResourceId | String | Product resource ID. |
| SharedMemberNum | Integer | Number of members in a sharing unit. |
| SharedMemberUseNum | Integer | Number of members using shared resources. |
| ShareManagerUin | Integer | Sharing unit administrator. |
Tag key-value pair.
Used by actions: AddOrganizationNode, CreateOrganizationMember, DescribeOrganizationMembers, DescribeOrganizationNodes, InviteOrganizationMember.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Tag compliance information.
Used by actions: ListNonCompliantResource.
| Name | Type | Description |
|---|---|---|
| ComplianceStatus | Boolean | Compliance status. true: compliant; false: non-compliant. |
| KeysWithNonCompliantValues | Array of String | List of tag keys with invalid values. |
| NonCompliantKeys | Array of String | List of invalid tag keys. |
Tag key-value pair.
Used by actions: ListNonCompliantResource.
| Name | Type | Description |
|---|---|---|
| TagKey | String | Tag key. |
| TagValue | String | Tag value. |
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 | Reason for failure |
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. |
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. |
| 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 |
| Password | String | No | User password. |
| NeedResetPassword | Boolean | No | Whether password reset is required next time. valid values: true (password reset required), false (not required to reset password). |
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. |
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. |
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. |
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. |
文档反馈