数据结构

最近更新时间: 2026-04-10 00:05:00

UserProvisioning

用户同步信息

被如下接口引用:GetUserSyncProvisioning、ListUserSyncProvisionings

名称 必选 允许NULL 类型 描述
TargetName String 集团账号目标账号的名称。
示例值: user1
DuplicationStrategy String 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。
示例值: KeepBoth
DeletionStrategy String 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。
示例值: Delete
CreateTime String 创建时间。
示例值: 2025-01-03 12:12:23
UpdateTime String 更新时间。
示例值: 2025-01-03 12:12:23
UserProvisioningId String CAM 用户同步的状态。取值:

Enabled:CAM 用户同步已启用。
Disabled:CAM 用户同步未启用。
示例值: up-sjisnw8ois
Status String CAM 用户同步的状态。取值:
Enabled:CAM 用户同步已启用。
Disabled:CAM 用户同步未启用。
示例值: Enabled
PrincipalName String CAM 用户同步的身份名称。取值:
当PrincipalType取值为Group时,该值为CIC用户组名称。
当PrincipalType取值为User时,该值为CIC用户名称。
示例值: user1
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值: User
TargetUin Int64 集团账号目标账号的UIN。
示例值: 111111111111
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值: MemberUin
Description String 描述。
示例值: description
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-
)。
示例值: u-xuec8dnd

GroupMembers

用户信息

被如下接口引用:ListGroupMembers

名称 必选 允许NULL 类型 描述
UserType String 用户类型  Manual:手动创建,Synchronized:外部导入。
示例值: Manual
UserId String 用户 ID
示例值: u-34nesn3u
JoinTime String 用户加入用户组的时间
示例值: 2025-01-03 12:12:23
UserName String 查询username。
示例值: Alice
DisplayName String 用户的显示名称。
示例值: Alice
Description String 用户的描述。
示例值: description
Email String 用户的电子邮箱。目录内必须唯一。
示例值: Alice@example.com
UserStatus String 用户状态 Enabled:启用, Disabled:禁用。
示例值: Enabled

TaskStatus

任务状态信息。

被如下接口引用:GetProvisioningTaskStatus

名称 必选 允许NULL 类型 描述
FailureReason String 任务失败原因。
说明
只有Status为Failed,才会显示该参数。
示例值: 失败
Status String 任务状态。取值:  InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
示例值: InProgress
TaskId String 任务 ID。
示例值: t-x8jd983n****
TaskType String 任务类型。取值:
ProvisionRoleConfiguration:部署权限配置。
DeprovisionRoleConfiguration:解除权限配置部署。
CreateRoleAssignment:在成员 账号上授权。
DeleteRoleAssignment:移除 成员 账号上的授权。
示例值: CreateRoleAssignment

JoinedGroups

用户加入的用户组

被如下接口引用:ListJoinedGroupsForUser

名称 必选 允许NULL 类型 描述
GroupName String 用户组的名称。
示例值: group_name
Description String 用户组的描述。
示例值: description
GroupId String 用户组 ID。
示例值: g-sd8sh8sdno***
GroupType String 用户组的类型。取值:

Manual:手动创建。
Synchronized:外部同步。
示例值: Manual
JoinTime String 加入用户组的时间
示例值: 2025-01-03 12:12:23

UserSyncProvisioning

CAM用户同步信息

被如下接口引用:CreateUserSyncProvisioning

名称 必选 允许NULL 类型 描述
Description String 描述。
示例值: his is cam user 
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-
)。
示例值: u-xuec8dnd
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值: User
TargetUin Int64 同步的集团账号目标账号的UIN。
示例值: 111111111111
DuplicationStrategy String 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。
示例值: KeepBoth
DeletionStrategy String 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。
示例值: Delete
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值: MemberUin

UserProvisioningsTask

用户同步任务状态信息。

被如下接口引用:CreateUserSyncProvisioning、DeleteUserSyncProvisioning

名称 必选 允许NULL 类型 描述
PrincipalType String CAM 用户同步的身份类型。取值: User:表示该 CAM 用户同步的身份是CIC 用户。 Group:表示该 CAM 用户同步的身份是CIC 用户组。
示例值: User
PrincipalName String 用户或者用户组名称。
示例值: user1
DeletionStrategy String 删除策略。Delete:删除;Keep:保留
示例值: Delete
TaskId String 任务ID。
示例值: t-x8jd983n****
TaskType String 任务类型。StartProvisioning:用户同步,DeleteProvisioning:删除用户同步
示例值: CreateRoleAssignment
TaskStatus String 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功
示例值: InProgress
UserProvisioningId String 用户同步ID。
示例值: up-sjisnw8ois
TargetUin Int64 授权的集团账号目标账号的UIN
示例值: 111111111111
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值: MemberUin
PrincipalId String  CAM 用户同步的身份 ID。取值: 当PrincipalType取值为Group时,该值为CIC 用户组 ID(g-)。 当PrincipalType取值为User时,该值为CIC 用户 ID(u-)。
示例值: u-xuec8dnd
DuplicationStrategy String 冲突策略。KeepBoth:两者都保留;TakeOver:替换
示例值: KeepBoth

GroupIdAndUserId

用户组ID和用户ID

被如下接口引用:BatchAddUserToGroup、BatchRemoveUserFromGroup

名称 必选 允许NULL 类型 描述
GroupId String 用户组ID
示例值: g-sd8sh8sdno***
UserId String 用户ID
示例值: u-34nesn3u

GroupInfo

用户组信息。

被如下接口引用:CreateGroup、GetGroup、ListGroups、UpdateGroup

名称 必选 允许NULL 类型 描述
GroupId String 用户组的 ID。
示例值: g-sd8sh8sdno***
MemberCount Int64 组员数量。
示例值: 1
IsSelected Bool 如果有入参FilterUsers,用户在用户组返回true,否则返回false
示例值: true
GroupName String 用户组的名称。
示例值: group_name
Description String 用户组的描述。
示例值: description
CreateTime String 用户组的创建时间。
示例值: 2025-01-03 12:12:23
GroupType String 用户组的类型  Manual:手动创建,Synchronized:外部导入。
示例值: Manual
UpdateTime String 用户组的修改时间。
示例值: 2025-01-03 12:12:23

SCIMCredential

SCIM密钥

被如下接口引用:ListSCIMCredentials

名称 必选 允许NULL 类型 描述
CreateTime String SCIM 密钥的创建时间。
示例值: 2025-01-03 12:12:23
ExpireTime String SCIM 密钥的过期时间。
示例值: 2025-01-03 12:12:23
ZoneId String 空间ID。z-前缀开头,后面是12位随机数字/小写字母
示例值: z-2d8shd8***
Status String SCIM密钥状态,Enabled已开启,Disabled已关闭。
示例值: Enabled
CredentialId String SCIM密钥ID。scimcred-前缀开头,后面是12位随机数字/小写字母。
示例值: scimcred-lkj****
CredentialType String SCIM密钥类型。
示例值: BearerToken

AccountUserProvisioning

成员账号用户同步配置信息

被如下接口引用:ListAccountsForUserProvisioning

名称 必选 允许NULL 类型 描述
Uin Int64 同步的目标成员账号uin
示例值: 111111111111
Name String 同步的目标成员账号名
示例值: member1
UserId String 用户ID
示例值: u-34nesn3u
SyncSubUin String 通过创建的子账号uin
示例值: 222222222222
SyncSubName String 同步创建的子账号名
示例值: sub_user

SAMLIdPCertificate

SAML 签名证书信息

被如下接口引用:ListExternalSAMLIdPCertificates

名称 必选 允许NULL 类型 描述
SerialNumber String 证书序列号。
示例值: 1347934239****
PublicKey String PEM 格式的公钥证书(Base64 编码)。
示例值: nMIIBtjCCAV***
SignatureAlgorithm String 证书的签名算法。
示例值: SHA256with***
NotAfter String 证书的过期时间。
示例值: 2030-06-23 07:09:11
NotBefore String 证书的创建时间。
示例值: 2023-06-23 07:09:11
Subject String 证书的主体。
示例值: 5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
X509Certificate String PEM 格式的 X509 证书。
示例值: nMIIBtjCCAV***
Issuer String 证书颁发者。
示例值: 5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
Version Int64 证书版本。
示例值: 1
CertificateId String 证书ID。
示例值: dp-c-2jd8923je29****

SAMLIdentityProviderConfiguration

saml 身份提供商配置信息。

被如下接口引用:GetExternalSAMLIdentityProvider

名称 必选 允许NULL 类型 描述
LoginUrl String IdP 的登录地址。
示例值: https://dev-xxxxx
CreateTime String 创建时间。
示例值: 2025-01-03 12:12:23
UpdateTime String 更新时间。
示例值: 2025-01-03 12:12:23
EntityId String IdP 标识。
示例值: http://www.***.com
SSOStatus String SSO 登录的启用状态。取值:  Enabled:启用。 Disabled(默认值):禁用。
示例值: Enbaled
EncodedMetadataDocument String IdP 元数据文档(Base64 编码)。
示例值: PD94bWwgdmVyc2lvbj0i***
CertificateIds Array of String X509证书ID。
示例值: dp-c-2jd8923je29****

UserInfo

用户信息

被如下接口引用:CreateUser、GetUser、ListUsers、UpdateUser

名称 必选 允许NULL 类型 描述
UserStatus String 用户状态 Enabled:启用, Disabled:禁用。
示例值: Enabled
UserType String 用户类型  Manual:手动创建,Synchronized:外部导入。
示例值: Manual
UserId String 用户 ID
示例值: u-34nesn3u
IsSelected Bool 是否选中
示例值: false
UserName String 查询username。
示例值: Alice
DisplayName String 用户的显示名称。
示例值: Alice
Description String 用户的描述。
示例值: description
Email String 用户的电子邮箱。目录内必须唯一。
示例值: Alice@example.com
CreateTime String 用户的创建时间
示例值: 2025-01-03 12:12:23
UpdateTime String 用户的修改时间
示例值: 2025-01-03 12:12:23
FirstName String 用户的名。
示例值: Alice
LastName String 用户的姓。
示例值: Alice

RoleConfiguration

CIC权限配置

被如下接口引用:CreateRoleConfiguration

名称 必选 允许NULL 类型 描述
RelayState String 初始访问页面。CIC 用户使用访问配置访问成员账号时,初始访问的页面地址。
示例值: https://XXX
CreateTime String 权限配置的创建时间。
示例值: 2025-01-03 12:12:23
UpdateTime String 权限配置的更新时间。
示例值: 2025-01-03 12:12:23
IsSelected Bool 如果有入参FilterTargets查询成员账号是否配置过权限,配置了返回true,否则返回false。
示例值: false
RoleConfigurationId String 权限配置配置ID。
示例值: rc-sisjdia
RoleConfigurationName String 权限配置配名称。
示例值: conf1
Description String 权限配置的描述。
示例值: description
SessionDuration Int64 会话持续时间。CIC 用户使用访问配置访问成员账号时,会话最多保持的时间。
单位:秒。
示例值: 60

CreateUserInfo

批量创建用户的用户信息

被如下接口引用:BatchCreateUser

名称 必选 允许NULL 类型 描述
UserName String 用户名称。空间内必须唯一。不支持修改。  格式:包含数字、英文字母和特殊符号+ = , . @ - _ 。  长度:最大 64 个字符
示例值: Alice
FirstName String 用户的姓。  长度:最大 64 个字符。
示例值: Alice
LastName String 用户的名。  长度:最大 64 个字符。
示例值: Alice
DisplayName String 用户的显示名称。  长度:最大 256 个字符。
示例值: Alice
Description String 用户的描述。  长度:最大 1024 个字符。
示例值: description
Email String 用户的电子邮箱。目录内必须唯一。  长度:最大 128 个字符。
示例值: Alice@example.com
UserStatus String 用户的状态。取值:  Enabled(默认值):启用。 Disabled:禁用。
示例值: Enabled

SAMLServiceProvider

SAML服务提供商信息

被如下接口引用:GetZoneSAMLServiceProviderInfo

名称 必选 允许NULL 类型 描述
EntityId String https://XXX/saml/sp/z-sjw8ensa
示例值: https://XXX/saml/sp/z-sjw8
*
ZoneId String 空间ID。
示例值: z-2d8shd8***
EncodedMetadataDocument String SP 元数据文档(Base64 编码)。
示例值: JTNDJTNGeG1sJTIwdmVyc2lvbiUzRCUyMjEuMCUyMiUyMGVuY29kaW5nJTNE***
AcsUrl String SP 的 ACS URL。
示例值: https://XXX.com/saml/acs/swedx-22a20du2-x2je9****

RoleAssignmentInfo

授权成员账号信息

被如下接口引用:CreateRoleAssignment

名称 必选 允许NULL 类型 描述
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-
)。
示例值: u-xuec8dnd
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值: User
TargetUin Int64 同步集团账号目标账号的UIN。
示例值: 111111111111
TargetType String 同步集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值: MemberUin
RoleConfigurationId String 权限配置ID。
示例值: rc-sisjdia

TaskInfo

任务状态信息。

被如下接口引用:CreateRoleAssignment

名称 必选 允许NULL 类型 描述
TaskId String 任务ID。
示例值: t-x8jd983n****
RoleConfigurationId String 权限配置ID。
示例值: rc-sisjdia
PrincipalId String 用户授权的身份ID,如果是身份类型是CIC用户,则为用户ID; 如果是用户组,则为用户组ID;
示例值: u-xuec8dnd
PrincipalType String 用户授权的身份类型, User代表CIC用户, Group代表CIC用户组
示例值: User
TaskType String 任务类型。
示例值: CreateRoleAssignment
Status String InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
示例值: InProgress
RoleConfigurationName String 权限配置名称。
示例值: conf1
TargetUin Int64 授权的目标成员账号的UIN
示例值: 111111111111
TargetType String 同步的目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值: MemberUin
FailureReason String 失败原因
示例值: 失败

ZoneStatistics

CIC的空间统计

被如下接口引用:GetZoneStatistics

名称 必选 允许NULL 类型 描述
RoleConfigurationSyncCount Int64 同步角色数。
示例值: 1
UserQuota Int64 用户配额。
示例值: 20
GroupQuota Int64 用户组配额。
示例值: 20
RoleConfigurationQuota Int64 权限配置配额。
示例值: 20
SystemPolicyPerRoleConfigurationQuota Int64 权限配置绑定的系统策略配额。
示例值: 20
UserCount Int64 用户数。
示例值: 1
GroupCount Int64 用户组数。
示例值: 1
RoleConfigurationCount Int64 权限配置数
示例值: 1
UserProvisioningCount Int64 同步用户数。
示例值: 1