tencentcloud-sdk-nodejs 4.0.360 → 4.0.363

package/src/services/ciam/v20220331/ciam_models.ts

@@ -0,0 +1,1087 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * UpdateUser请求参数结构体
+ */
+export interface UpdateUserRequest {
+  /**
+   * 用户ID
+   */
+  UserId: string
+
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 用户名称
+   */
+  UserName?: string
+
+  /**
+   * 手机号码
+   */
+  PhoneNumber?: string
+
+  /**
+   * 邮箱
+   */
+  Email?: string
+
+  /**
+   * 昵称
+   */
+  Nickname?: string
+
+  /**
+   * 地址
+   */
+  Address?: string
+
+  /**
+   * 用户组
+   */
+  UserGroup?: Array<string>
+
+  /**
+   * 生日
+   */
+  Birthdate?: number
+
+  /**
+   * 自定义属性
+   */
+  CustomizationAttributes?: Array<MemberMap>
+}
+
+/**
+ * DescribeUserById请求参数结构体
+ */
+export interface DescribeUserByIdRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 用户ID
+   */
+  UserId: string
+}
+
+/**
+ * ListUser请求参数结构体
+ */
+export interface ListUserRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 分页数据
+   */
+  Pageable: Pageable
+
+  /**
+      * Key可选值为condition、userGroupId
+
+<li> **condition** </li>	Values = 查询条件，用户ID，用户名称，手机或邮箱
+<li> **userGroupId** </li>	Values = 用户组ID
+      */
+  Filters?: Array<Filter>
+}
+
+/**
+ * ResetPassword请求参数结构体
+ */
+export interface ResetPasswordRequest {
+  /**
+   * 用户ID
+   */
+  UserId: string
+
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+}
+
+/**
+ * 失败详情
+ */
+export interface ErrorDetails {
+  /**
+      * 用户信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserId: string
+
+  /**
+   * 失败原因
+   */
+  Error: string
+}
+
+/**
+ * DeleteUsers请求参数结构体
+ */
+export interface DeleteUsersRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 用户ID数组
+   */
+  UserIds: Array<string>
+}
+
+/**
+ * 导入用户信息
+1、UserName，PhoneNumber ，Email ，WechatOpenId ，WechatUnionId ，AlipayUserId ，QqOpenId ，QqUnionId 八个属性中，导入时必须包含其中一个属性并遵守初始化自定义属性的正则表达式规则。UserName，PhoneNumber，Email的正则表达式在控制台的自定义属性中可以查询到。
+2、对于密码的导入，导入的密码支持明文导入，MD5密文导入，SHA1密文导入，BCRYPT密文导入 ，这个需要在PasswordEncryptTypeEnum 字段中指定。
+3、IdentityVerified，IdentityVerificationMethod 支持导入，
+IdentityVerified 为true，IdentityVerificationMethod必传；
+IdentityVerificationMethod 为nameAndIdCard，Name,ResidentIdentityCard必传
+IdentityVerificationMethod 为nameIdCardAndPhone，Name,PhoneNumber,ResidentIdentityCard必传;
+ */
+export interface ImportUser {
+  /**
+   * 用户名
+   */
+  UserName?: string
+
+  /**
+   * 手机号
+   */
+  PhoneNumber?: string
+
+  /**
+   * 邮箱
+   */
+  Email?: string
+
+  /**
+   * 身份证号
+   */
+  ResidentIdentityCard?: string
+
+  /**
+   * 昵称
+   */
+  Nickname?: string
+
+  /**
+   * 地址
+   */
+  Address?: string
+
+  /**
+   * 用户组ID
+   */
+  UserGroup?: Array<string>
+
+  /**
+   * QQ qqOpenId
+   */
+  QqOpenId?: string
+
+  /**
+   * QQ qqUnionId
+   */
+  QqUnionId?: string
+
+  /**
+   * 微信wechatOpenId
+   */
+  WechatOpenId?: string
+
+  /**
+   * 微信wechatUnionId
+   */
+  WechatUnionId?: string
+
+  /**
+   * 支付宝alipayUserId
+   */
+  AlipayUserId?: string
+
+  /**
+   * 描述
+   */
+  Description?: string
+
+  /**
+   * 生日
+   */
+  Birthdate?: string
+
+  /**
+   * 姓名
+   */
+  Name?: string
+
+  /**
+   * 坐标
+   */
+  Locale?: string
+
+  /**
+   * 性别（MALE;FEMALE;UNKNOWN）
+   */
+  Gender?: string
+
+  /**
+   * 实名核验方式
+   */
+  IdentityVerificationMethod?: string
+
+  /**
+   * 是否已实名核验
+   */
+  IdentityVerified?: boolean
+
+  /**
+   * 工作
+   */
+  Job?: string
+
+  /**
+   * 国家
+   */
+  Nationality?: string
+
+  /**
+   * 时区
+   */
+  Zone?: string
+
+  /**
+   * 密码密文
+   */
+  Password?: string
+
+  /**
+   * 自定义属性
+   */
+  CustomizationAttributes?: Array<MemberMap>
+
+  /**
+   * 密码盐
+   */
+  Salt?: Salt
+
+  /**
+   * 密码加密方式（SHA1;BCRYPT）
+   */
+  PasswordEncryptTypeEnum?: string
+}
+
+/**
+ * UpdateUserStatus返回参数结构体
+ */
+export interface UpdateUserStatusResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 失败的用户
+ */
+export interface FailedUsers {
+  /**
+      * 失败用户标识
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailedUserIdentification: string
+
+  /**
+      * 导入的用户失败原因
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailedReason: string
+}
+
+/**
+ * ListUserByProperty请求参数结构体
+ */
+export interface ListUserByPropertyRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+      * 查询的属性
+
+<li> **phoneNumber** </li>	  手机号码
+<li> **email** </li>  邮箱
+      */
+  PropertyCode: string
+
+  /**
+   * 属性值
+   */
+  PropertyValue: string
+}
+
+/**
+ * CreateUser返回参数结构体
+ */
+export interface CreateUserResponse {
+  /**
+      * 创建的用户信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  User: User
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 查询条件
+ */
+export interface Filter {
+  /**
+   * key值
+   */
+  Key?: string
+
+  /**
+   * value值
+   */
+  Values?: Array<string>
+
+  /**
+   * 逻辑值
+   */
+  Logic?: boolean
+}
+
+/**
+ * SetPassword返回参数结构体
+ */
+export interface SetPasswordResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * ListUserByProperty返回参数结构体
+ */
+export interface ListUserByPropertyResponse {
+  /**
+      * 用户列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Users: Array<User>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * ListJobs请求参数结构体
+ */
+export interface ListJobsRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 任务ID列表，为空时返回全部任务
+   */
+  JobIds?: Array<string>
+}
+
+/**
+ * DescribeUserById返回参数结构体
+ */
+export interface DescribeUserByIdResponse {
+  /**
+      * 用户信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  User: User
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 任务详情
+ */
+export interface Job {
+  /**
+   * 任务ID
+   */
+  Id: string
+
+  /**
+      * 任务状态
+
+<li> **PENDING** </li>  待执行
+<li> **PROCESSING** </li>  执行中
+<li> **COMPLETED** </li>  完成
+<li> **FAILED** </li>  失败
+      */
+  Status: string
+
+  /**
+      * 任务类型
+
+<li> **IMPORT_USER** </li>  用户导入
+<li> **EXPORT_USER** </li>  用户导出
+      */
+  Type: string
+
+  /**
+   * 任务创建时间
+   */
+  CreatedDate: number
+
+  /**
+      * 任务的数据类型
+
+<li> **JSON** </li>  JSON
+<li> **NDJSON** </li>  New-line Delimited JSON
+<li> **CSV** </li>  Comma-Separated Values
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Format: string
+
+  /**
+      * 任务结果下载地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Location: string
+
+  /**
+      * 失败详情
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ErrorDetails: Array<ErrorDetails>
+
+  /**
+      * 失败的用户
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FailedUsers: Array<FailedUsers>
+}
+
+/**
+ * CreateFileExportUserJob请求参数结构体
+ */
+export interface CreateFileExportUserJobRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+      * 导出的数据类型
+
+<li> **JSON** </li>  JSON
+<li> **NDJSON** </li>  New-line Delimited JSON
+<li> **CSV** </li>  Comma-Separated Values
+      */
+  Format?: string
+
+  /**
+      * Key可选值为condition、userGroupId
+
+<li> **condition** </li>	Values = 查询条件，用户ID，用户名称，手机或邮箱
+<li> **userGroupId** </li>	Values = 用户组ID
+      */
+  Filters?: Array<Filter>
+
+  /**
+   * 导出用户包含的属性和映射名称，为空时包含所有的属性
+   */
+  ExportPropertyMaps?: Array<ExportPropertyMap>
+}
+
+/**
+ * 用户信息
+ */
+export interface User {
+  /**
+   * 用户ID
+   */
+  UserId: string
+
+  /**
+      * 用户名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserName: string
+
+  /**
+      * 手机号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  PhoneNumber: string
+
+  /**
+      * 邮箱
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Email: string
+
+  /**
+      * 上次登录时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LastSignOn: number
+
+  /**
+   * 创建时间
+   */
+  CreatedDate: number
+
+  /**
+   * 状态
+   */
+  Status: string
+
+  /**
+   * 用户来源
+   */
+  UserDataSourceEnum: string
+
+  /**
+      * 昵称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Nickname: string
+
+  /**
+      * 地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Address: string
+
+  /**
+      * 生日
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Birthdate: number
+
+  /**
+      * 用户组ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserGroups: Array<string>
+
+  /**
+      * 上次修改时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LastModifiedDate: number
+
+  /**
+      * 自定义属性
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CustomAttributes: Array<MemberMap>
+
+  /**
+      * 身份证号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ResidentIdentityCard: string
+
+  /**
+      * QQ的OpenId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  QqOpenId: string
+
+  /**
+      * QQ的UnionId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  QqUnionId: string
+
+  /**
+      * 微信的WechatOpenId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  WechatOpenId: string
+
+  /**
+      * 微信的WechatUnionId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  WechatUnionId: string
+
+  /**
+      * 支付宝的AlipayUserId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AlipayUserId: string
+
+  /**
+      * 描述
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Description: string
+
+  /**
+      * 姓名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Name: string
+
+  /**
+      * 坐标
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Locale: string
+
+  /**
+      * 性别
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Gender: string
+
+  /**
+      * 实名核验方式
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdentityVerificationMethod: string
+
+  /**
+      * 是否已经实名核验
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdentityVerified: boolean
+
+  /**
+      * 工作
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Job: string
+
+  /**
+      * 国家
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Nationality: string
+
+  /**
+      * 是否主账号（进行过账号融合后，主账号为true，从账号为false）
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Primary: boolean
+
+  /**
+      * 时区
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Zone: string
+
+  /**
+      * 是否已经首次登录
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AlreadyFirstLogin: boolean
+
+  /**
+      * 租户id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  TenantId: string
+
+  /**
+      * 用户目录id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserStoreId: string
+
+  /**
+      * 版本
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Version: number
+
+  /**
+      * 锁定类型（分为管理员锁定，和登录策略锁定）
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LockType: string
+
+  /**
+      * 锁定时间点
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LockTime: number
+}
+
+/**
+ * 分页对象
+ */
+export interface Pageable {
+  /**
+   * 每页数量
+   */
+  PageSize: number
+
+  /**
+   * 当前页码
+   */
+  PageNumber: number
+}
+
+/**
+ * ResetPassword返回参数结构体
+ */
+export interface ResetPasswordResponse {
+  /**
+   * 重置后的用户密码
+   */
+  Password: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * SetPassword请求参数结构体
+ */
+export interface SetPasswordRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 用户ID
+   */
+  UserId: string
+
+  /**
+   * 密码
+   */
+  Password: string
+}
+
+/**
+ * 盐位
+ */
+export type SaltLocation = null
+
+/**
+ * UpdateUserStatus请求参数结构体
+ */
+export interface UpdateUserStatusRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 用户ID
+   */
+  UserId: string
+
+  /**
+      * 用户状态
+
+<li> **NORMAL** </li>	  正常
+<li> **LOCK** </li>  锁定
+<li> **FREEZE** </li>	  冻结
+      */
+  Status: string
+}
+
+/**
+ * ListJobs返回参数结构体
+ */
+export interface ListJobsResponse {
+  /**
+      * 任务列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  JobSet: Array<Job>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 导出属性映射
+ */
+export interface ExportPropertyMap {
+  /**
+   * 用户属性code
+   */
+  UserPropertyCode: string
+
+  /**
+   * 用户属性映射名称
+   */
+  ColumnName: string
+}
+
+/**
+ * LinkAccount返回参数结构体
+ */
+export interface LinkAccountResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateUser请求参数结构体
+ */
+export interface CreateUserRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 手机号码
+   */
+  PhoneNumber: string
+
+  /**
+   * 邮箱
+   */
+  Email: string
+
+  /**
+   * 密码
+   */
+  Password: string
+
+  /**
+   * 用户名
+   */
+  UserName: string
+
+  /**
+   * 昵称
+   */
+  Nickname?: string
+
+  /**
+   * 地址
+   */
+  Address?: string
+
+  /**
+   * 用户组ID
+   */
+  UserGroup?: Array<string>
+
+  /**
+   * 生日
+   */
+  Birthdate?: number
+
+  /**
+   * 自定义属性
+   */
+  CustomizationAttributes?: Array<MemberMap>
+}
+
+/**
+ * 密码盐
+ */
+export interface Salt {
+  /**
+   * 盐值
+   */
+  SaltValue?: string
+
+  /**
+   * 盐值位置
+   */
+  SaltLocation?: SaltLocation
+}
+
+/**
+ * DeleteUsers返回参数结构体
+ */
+export interface DeleteUsersResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateApiImportUserJob请求参数结构体
+ */
+export interface CreateApiImportUserJobRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 导入的用户数据
+   */
+  DataFlowUserCreateList: Array<ImportUser>
+}
+
+/**
+ * CreateFileExportUserJob返回参数结构体
+ */
+export interface CreateFileExportUserJobResponse {
+  /**
+   * 数据流任务
+   */
+  Job: Job
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateApiImportUserJob返回参数结构体
+ */
+export interface CreateApiImportUserJobResponse {
+  /**
+   * 数据流任务
+   */
+  Job: Job
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * LinkAccount请求参数结构体
+ */
+export interface LinkAccountRequest {
+  /**
+   * 用户目录ID
+   */
+  UserStoreId: string
+
+  /**
+   * 主用户ID
+   */
+  PrimaryUserId: string
+
+  /**
+   * 从用户ID
+   */
+  SecondaryUserId: string
+
+  /**
+      * 融合属性
+
+<li> **PHONENUMBER** </li>	  手机号码
+<li> **EMAIL** </li>  邮箱
+      */
+  UserLinkedOnAttribute: string
+}
+
+/**
+ * Map数据类型
+ */
+export interface MemberMap {
+  /**
+   * 健
+   */
+  Name: string
+
+  /**
+   * 值
+   */
+  Value: string
+
+  /**
+      * 类型
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Type?: string
+}
+
+/**
+ * ListUser返回参数结构体
+ */
+export interface ListUserResponse {
+  /**
+      * 总条数
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Total: number
+
+  /**
+      * 分页对象
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Pageable: Pageable
+
+  /**
+      * 用户列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Content: Array<User>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * UpdateUser返回参数结构体
+ */
+export interface UpdateUserResponse {
+  /**
+      * 更新之后的用户信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  User: User
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}