{
  "name": "ciam",
  "display_name": "账号风控平台",
  "description": "介绍如何使用ciam进行用户管理、用户导入导出等管理动作",
  "domain": "other",
  "api_version": "2022-03-31",
  "endpoint": "ciam.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateApiImportUserJob",
      "description": "新建接口导入用户任务",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "DataFlowUserCreateList",
          "type": "array",
          "required": true,
          "description": "导入的用户数据",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名",
              "example": "zhangsan"
            },
            {
              "name": "PhoneNumber",
              "type": "string",
              "required": false,
              "description": "手机号",
              "example": "132****0000"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "邮箱",
              "example": "132****@qq.com"
            },
            {
              "name": "ResidentIdentityCard",
              "type": "string",
              "required": false,
              "description": "身份证号",
              "example": "123456789012345678"
            },
            {
              "name": "Nickname",
              "type": "string",
              "required": false,
              "description": "昵称",
              "example": "昵称1"
            },
            {
              "name": "Address",
              "type": "string",
              "required": false,
              "description": "地址",
              "example": "北京市海淀区"
            },
            {
              "name": "UserGroup",
              "type": "array",
              "required": false,
              "description": "用户组ID",
              "example": "[6cd22e51****************f6f7cb81]",
              "item_type": "string"
            },
            {
              "name": "QqOpenId",
              "type": "string",
              "required": false,
              "description": "QQ qqOpenId",
              "example": "qqopenid"
            },
            {
              "name": "QqUnionId",
              "type": "string",
              "required": false,
              "description": "QQ qqUnionId",
              "example": "qqunionid"
            },
            {
              "name": "WechatOpenId",
              "type": "string",
              "required": false,
              "description": "微信wechatOpenId",
              "example": "wechatopenid"
            },
            {
              "name": "WechatUnionId",
              "type": "string",
              "required": false,
              "description": "微信wechatUnionId",
              "example": "wechatunionid"
            },
            {
              "name": "AlipayUserId",
              "type": "string",
              "required": false,
              "description": "支付宝alipayUserId",
              "example": "alipayuserid"
            },
            {
              "name": "WeComUserId",
              "type": "string",
              "required": false,
              "description": "企业微信weComUserId",
              "example": "wecomuserid"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "描述",
              "example": "用户1"
            },
            {
              "name": "Birthdate",
              "type": "string",
              "required": false,
              "description": "生日",
              "example": "1722420973329"
            },
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "姓名",
              "example": "姓名"
            },
            {
              "name": "Locale",
              "type": "string",
              "required": false,
              "description": "坐标",
              "example": "地理位置"
            },
            {
              "name": "Gender",
              "type": "string",
              "required": false,
              "description": "性别（MALE;FEMALE;UNKNOWN）",
              "example": "男"
            },
            {
              "name": "IdentityVerificationMethod",
              "type": "string",
              "required": false,
              "description": "实名核验方式",
              "example": "nameAndIdCard"
            },
            {
              "name": "IdentityVerified",
              "type": "boolean",
              "required": false,
              "description": "是否已实名核验",
              "example": "true"
            },
            {
              "name": "Job",
              "type": "string",
              "required": false,
              "description": "工作",
              "example": "员工"
            },
            {
              "name": "Nationality",
              "type": "string",
              "required": false,
              "description": "国家",
              "example": "汉族"
            },
            {
              "name": "Zone",
              "type": "string",
              "required": false,
              "description": "时区",
              "example": "时区"
            },
            {
              "name": "Password",
              "type": "string",
              "required": false,
              "description": "密码密文",
              "example": "password"
            },
            {
              "name": "CustomizationAttributes",
              "type": "array",
              "required": false,
              "description": "自定义属性",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "健",
                  "example": "name"
                },
                {
                  "name": "Value",
                  "type": "string",
                  "required": true,
                  "description": "值",
                  "example": "value"
                },
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "类型",
                  "example": "STRING"
                }
              ]
            },
            {
              "name": "Salt",
              "type": "object",
              "required": false,
              "description": "密码盐",
              "example": "无",
              "children": [
                {
                  "name": "SaltValue",
                  "type": "string",
                  "required": false,
                  "description": "盐值",
                  "example": "salt****"
                },
                {
                  "name": "SaltLocation",
                  "type": "object",
                  "required": false,
                  "description": "盐值位置",
                  "example": "无",
                  "children": [
                    {
                      "name": "SaltLocationTypeEnum",
                      "type": "string",
                      "required": false,
                      "description": "密码加盐的类型（HEAD，TAIL，OTHER）",
                      "example": "HEAD"
                    },
                    {
                      "name": "SaltLocationRule",
                      "type": "object",
                      "required": false,
                      "description": "加盐规则",
                      "example": "无"
                    }
                  ]
                }
              ]
            },
            {
              "name": "PasswordEncryptTypeEnum",
              "type": "string",
              "required": false,
              "description": "密码加密方式（SHA1;BCRYPT）",
              "example": "SHA1"
            },
            {
              "name": "IndexedAttribute1",
              "type": "string",
              "required": false,
              "description": "索引字段1",
              "example": "value1"
            },
            {
              "name": "IndexedAttribute2",
              "type": "string",
              "required": false,
              "description": "索引字段2",
              "example": "value2"
            },
            {
              "name": "IndexedAttribute3",
              "type": "string",
              "required": false,
              "description": "索引字段3",
              "example": "value3"
            },
            {
              "name": "IndexedAttribute4",
              "type": "string",
              "required": false,
              "description": "索引字段4",
              "example": "value4"
            },
            {
              "name": "IndexedAttribute5",
              "type": "string",
              "required": false,
              "description": "索引字段5",
              "example": "value5"
            }
          ]
        }
      ],
      "required": [
        "UserStoreId",
        "DataFlowUserCreateList"
      ]
    },
    {
      "name": "CreateFileExportUserJob",
      "description": "新建文件导出用户任务",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Format",
          "type": "string",
          "required": false,
          "description": "导出的数据类型 **NDJSON** New-line Delimited JSON **CSV** Comma-Separated Values",
          "example": "NDJSON"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "Key可选值为condition、userGroupId **condition** Values = 查询条件，用户ID，用户名称，手机或邮箱 **userGroupId** Values = 用户组ID",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": false,
              "description": "key值",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "value值",
              "example": "[value1, value2]",
              "item_type": "string"
            },
            {
              "name": "Logic",
              "type": "boolean",
              "required": false,
              "description": "逻辑值",
              "example": "true"
            }
          ]
        },
        {
          "name": "ExportPropertyMaps",
          "type": "array",
          "required": false,
          "description": "导出用户包含的属性和映射名称，为空时包含所有的属性",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserPropertyCode",
              "type": "string",
              "required": true,
              "description": "用户属性code",
              "example": "nickname"
            },
            {
              "name": "ColumnName",
              "type": "string",
              "required": true,
              "description": "用户属性映射名称",
              "example": "昵称"
            }
          ]
        }
      ],
      "required": [
        "UserStoreId"
      ]
    },
    {
      "name": "CreateUser",
      "description": "创建用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "PhoneNumber",
          "type": "string",
          "required": true,
          "description": "手机号码",
          "example": "132****0000"
        },
        {
          "name": "Email",
          "type": "string",
          "required": true,
          "description": "邮箱",
          "example": "132****@qq.com"
        },
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "password"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "zhangsan"
        },
        {
          "name": "Nickname",
          "type": "string",
          "required": false,
          "description": "昵称",
          "example": "昵称1"
        },
        {
          "name": "Address",
          "type": "string",
          "required": false,
          "description": "地址",
          "example": "北京市海淀区"
        },
        {
          "name": "UserGroup",
          "type": "array",
          "required": false,
          "description": "用户组ID",
          "example": "[6cd22e51****************f6f7cb81]",
          "item_type": "string"
        },
        {
          "name": "Birthdate",
          "type": "integer",
          "required": false,
          "description": "生日",
          "example": "1706682491339"
        },
        {
          "name": "CustomizationAttributes",
          "type": "array",
          "required": false,
          "description": "自定义属性",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "健",
              "example": "name"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "值",
              "example": "value"
            },
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "类型",
              "example": "STRING"
            }
          ]
        },
        {
          "name": "IndexedAttribute1",
          "type": "string",
          "required": false,
          "description": "索引字段1",
          "example": "value1"
        },
        {
          "name": "IndexedAttribute2",
          "type": "string",
          "required": false,
          "description": "索引字段2",
          "example": "value2"
        },
        {
          "name": "IndexedAttribute3",
          "type": "string",
          "required": false,
          "description": "索引字段3",
          "example": "value3"
        },
        {
          "name": "IndexedAttribute4",
          "type": "string",
          "required": false,
          "description": "索引字段4",
          "example": "value4"
        },
        {
          "name": "IndexedAttribute5",
          "type": "string",
          "required": false,
          "description": "索引字段5",
          "example": "value5"
        }
      ],
      "required": [
        "UserStoreId",
        "PhoneNumber",
        "Email",
        "Password",
        "UserName"
      ]
    },
    {
      "name": "CreateUserGroup",
      "description": "创建用户组",
      "status": "online",
      "parameters": [
        {
          "name": "DisplayName",
          "type": "string",
          "required": true,
          "description": "用户组名称",
          "example": "用户组1"
        },
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "用户组描述",
          "example": "包含了一组用户"
        }
      ],
      "required": [
        "DisplayName",
        "UserStoreId"
      ]
    },
    {
      "name": "CreateUserStore",
      "description": "创建用户目录",
      "status": "online",
      "parameters": [
        {
          "name": "UserPoolName",
          "type": "string",
          "required": true,
          "description": "用户池名字",
          "example": "目录1"
        },
        {
          "name": "UserPoolDesc",
          "type": "string",
          "required": false,
          "description": "用户池描述",
          "example": "管理应用和用户"
        },
        {
          "name": "UserPoolLogo",
          "type": "string",
          "required": false,
          "description": "用户池logo",
          "example": "https://aa.com/bb.png"
        }
      ],
      "required": [
        "UserPoolName"
      ]
    },
    {
      "name": "DeleteUserGroups",
      "description": "批量删除用户组",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupIds",
          "type": "array",
          "required": true,
          "description": "用户组ID数组",
          "example": "[6cd22e51****************f6f7cb81]",
          "item_type": "string"
        },
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        }
      ],
      "required": [
        "UserGroupIds",
        "UserStoreId"
      ]
    },
    {
      "name": "DeleteUserStore",
      "description": "删除用户目录",
      "status": "online",
      "parameters": [
        {
          "name": "UserPoolId",
          "type": "string",
          "required": true,
          "description": "用户池ID",
          "example": "2c3aca3b****************a7efe88e"
        }
      ],
      "required": [
        "UserPoolId"
      ]
    },
    {
      "name": "DeleteUsers",
      "description": "批量删除用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "用户ID数组",
          "example": "[53e25c3****************e4eb5bd1]",
          "item_type": "string"
        }
      ],
      "required": [
        "UserStoreId",
        "UserIds"
      ]
    },
    {
      "name": "DescribeUser",
      "description": "多条件查询用户信息",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Pageable",
          "type": "object",
          "required": true,
          "description": "分页数据",
          "example": "无",
          "children": [
            {
              "name": "PageSize",
              "type": "integer",
              "required": true,
              "description": "每页数量",
              "example": "10"
            },
            {
              "name": "PageNumber",
              "type": "integer",
              "required": true,
              "description": "当前页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询条件，根据propertycode和propertykey",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "PropertyKey",
              "type": "string",
              "required": false,
              "description": "属性key",
              "example": "username"
            },
            {
              "name": "PropertyValue",
              "type": "string",
              "required": false,
              "description": "属性value",
              "example": "zhangsan"
            },
            {
              "name": "Logic",
              "type": "boolean",
              "required": false,
              "description": "逻辑值，等于true，不等于false",
              "example": "true"
            },
            {
              "name": "OperateLogic",
              "type": "string",
              "required": false,
              "description": "操作逻辑符（支持\u003e = \u003c= != between）",
              "example": "!="
            }
          ]
        },
        {
          "name": "Original",
          "type": "boolean",
          "required": false,
          "description": "是否返回明文",
          "example": "true"
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序设置",
          "example": "createTime",
          "children": [
            {
              "name": "PropertyKey",
              "type": "string",
              "required": false,
              "description": "排序字段的key，参考自定义属性",
              "example": "name"
            },
            {
              "name": "Order",
              "type": "string",
              "required": false,
              "description": "升序或者降序，ASC/DESC",
              "example": "DESC"
            }
          ]
        }
      ],
      "required": [
        "UserStoreId",
        "Pageable"
      ]
    },
    {
      "name": "DescribeUserById",
      "description": "根据ID查询用户信息",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "Original",
          "type": "boolean",
          "required": false,
          "description": "返回信息是否为原文 **false** 默认，返回信息为脱敏信息 **true** 返回用户信息原文",
          "example": "true"
        }
      ],
      "required": [
        "UserStoreId",
        "UserId"
      ]
    },
    {
      "name": "LinkAccount",
      "description": "账号融合",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "PrimaryUserId",
          "type": "string",
          "required": true,
          "description": "主用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "SecondaryUserId",
          "type": "string",
          "required": true,
          "description": "从用户ID",
          "example": "081820ad****************5c58d1ad"
        },
        {
          "name": "UserLinkedOnAttribute",
          "type": "string",
          "required": true,
          "description": "融合属性 **PHONENUMBER** 手机号码 **EMAIL** 邮箱",
          "example": "PHONENUMBER"
        }
      ],
      "required": [
        "UserStoreId",
        "PrimaryUserId",
        "SecondaryUserId",
        "UserLinkedOnAttribute"
      ]
    },
    {
      "name": "ListJobs",
      "description": "查询任务详情",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "JobIds",
          "type": "array",
          "required": false,
          "description": "任务ID列表，为空时返回全部任务",
          "example": "[c29f2c0f****************405ec698]",
          "item_type": "string"
        }
      ],
      "required": [
        "UserStoreId"
      ]
    },
    {
      "name": "ListLogMessageByCondition",
      "description": "查询日志信息",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户池ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Pageable",
          "type": "object",
          "required": true,
          "description": "分页数据",
          "example": "无",
          "children": [
            {
              "name": "PageSize",
              "type": "integer",
              "required": true,
              "description": "每页数量",
              "example": "10"
            },
            {
              "name": "PageNumber",
              "type": "integer",
              "required": true,
              "description": "当前页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间，时间戳精确到毫秒",
          "example": "1703385600000"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "Key可选值为events **events** Values为[\"SIGNUP\", \"USER_UPDATE\", \"USER_DELETE\", \"USER_CREATE\", \"ACCOUNT_LINKING\"] 中的一个或多个",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": false,
              "description": "key值",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "value值",
              "example": "[value1, value2]",
              "item_type": "string"
            },
            {
              "name": "Logic",
              "type": "boolean",
              "required": false,
              "description": "逻辑值",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "UserStoreId",
        "Pageable",
        "StartTime"
      ]
    },
    {
      "name": "ListUser",
      "description": "查询用户列表",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Pageable",
          "type": "object",
          "required": true,
          "description": "分页数据",
          "example": "无",
          "children": [
            {
              "name": "PageSize",
              "type": "integer",
              "required": true,
              "description": "每页数量",
              "example": "10"
            },
            {
              "name": "PageNumber",
              "type": "integer",
              "required": true,
              "description": "当前页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "Key可选值为condition、userGroupId **condition** Values = 查询条件，用户ID，用户名称，手机或邮箱 **userGroupId** Values = 用户组ID",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": false,
              "description": "key值",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "value值",
              "example": "[value1, value2]",
              "item_type": "string"
            },
            {
              "name": "Logic",
              "type": "boolean",
              "required": false,
              "description": "逻辑值",
              "example": "true"
            }
          ]
        },
        {
          "name": "Original",
          "type": "boolean",
          "required": false,
          "description": "返回信息是否为原文",
          "example": "true"
        }
      ],
      "required": [
        "UserStoreId",
        "Pageable"
      ]
    },
    {
      "name": "ListUserByProperty",
      "description": "根据属性查询用户列表",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "PropertyCode",
          "type": "string",
          "required": true,
          "description": "查询的属性 **phoneNumber** 手机号码 **email** 邮箱",
          "example": "phoneNumber"
        },
        {
          "name": "PropertyValue",
          "type": "string",
          "required": true,
          "description": "属性值",
          "example": "130****0000"
        },
        {
          "name": "Original",
          "type": "boolean",
          "required": false,
          "description": "返回信息是否为原文",
          "example": "true"
        }
      ],
      "required": [
        "UserStoreId",
        "PropertyCode",
        "PropertyValue"
      ]
    },
    {
      "name": "ListUserGroups",
      "description": "查询用户组列表",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Pageable",
          "type": "object",
          "required": true,
          "description": "分页数据",
          "example": "无",
          "children": [
            {
              "name": "PageSize",
              "type": "integer",
              "required": true,
              "description": "每页数量",
              "example": "10"
            },
            {
              "name": "PageNumber",
              "type": "integer",
              "required": true,
              "description": "当前页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "Key可选值为condition **condition** Values = 查询条件，用户组ID或用户组名称",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": false,
              "description": "key值",
              "example": "key"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "value值",
              "example": "[value1, value2]",
              "item_type": "string"
            },
            {
              "name": "Logic",
              "type": "boolean",
              "required": false,
              "description": "逻辑值",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "UserStoreId",
        "Pageable"
      ]
    },
    {
      "name": "ListUserStore",
      "description": "查询用户目录列表",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ResetPassword",
      "description": "重置用户密码",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        }
      ],
      "required": [
        "UserId",
        "UserStoreId"
      ]
    },
    {
      "name": "SetPassword",
      "description": "设置用户密码",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "password"
        }
      ],
      "required": [
        "UserStoreId",
        "UserId",
        "Password"
      ]
    },
    {
      "name": "UpdateUser",
      "description": "更新用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名称",
          "example": "zhangsan"
        },
        {
          "name": "PhoneNumber",
          "type": "string",
          "required": false,
          "description": "手机号码",
          "example": "132****0000"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "邮箱",
          "example": "132****@qq.com"
        },
        {
          "name": "Nickname",
          "type": "string",
          "required": false,
          "description": "昵称",
          "example": "昵称1"
        },
        {
          "name": "Address",
          "type": "string",
          "required": false,
          "description": "地址",
          "example": "北京市海淀区"
        },
        {
          "name": "UserGroup",
          "type": "array",
          "required": false,
          "description": "用户组",
          "example": "[\"6cd22e51****************f6f7cb81\"]",
          "item_type": "string"
        },
        {
          "name": "Birthdate",
          "type": "integer",
          "required": false,
          "description": "生日",
          "example": "1706682491339"
        },
        {
          "name": "CustomizationAttributes",
          "type": "array",
          "required": false,
          "description": "自定义属性",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "健",
              "example": "name"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "值",
              "example": "value"
            },
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "类型",
              "example": "STRING"
            }
          ]
        },
        {
          "name": "IndexedAttribute1",
          "type": "string",
          "required": false,
          "description": "索引字段1",
          "example": "value1"
        },
        {
          "name": "IndexedAttribute2",
          "type": "string",
          "required": false,
          "description": "索引字段2",
          "example": "value2"
        },
        {
          "name": "IndexedAttribute3",
          "type": "string",
          "required": false,
          "description": "索引字段3",
          "example": "value3"
        },
        {
          "name": "IndexedAttribute4",
          "type": "string",
          "required": false,
          "description": "索引字段4",
          "example": "value4"
        },
        {
          "name": "IndexedAttribute5",
          "type": "string",
          "required": false,
          "description": "索引字段5",
          "example": "value5"
        }
      ],
      "required": [
        "UserId",
        "UserStoreId"
      ]
    },
    {
      "name": "UpdateUserGroup",
      "description": "更新用户组",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID",
          "example": "6cd22e51****************f6f7cb81"
        },
        {
          "name": "DisplayName",
          "type": "string",
          "required": true,
          "description": "用户组名称",
          "example": "用户组1"
        },
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "用户组描述",
          "example": "包含了一组用户"
        }
      ],
      "required": [
        "UserGroupId",
        "DisplayName",
        "UserStoreId"
      ]
    },
    {
      "name": "UpdateUserStatus",
      "description": "更新用户状态",
      "status": "online",
      "parameters": [
        {
          "name": "UserStoreId",
          "type": "string",
          "required": true,
          "description": "用户目录ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "53e25c3****************e4eb5bd1"
        },
        {
          "name": "Status",
          "type": "string",
          "required": true,
          "description": "用户状态 **NORMAL** 正常 **LOCK** 锁定 **FREEZE** 冻结",
          "example": "NORMAL"
        }
      ],
      "required": [
        "UserStoreId",
        "UserId",
        "Status"
      ]
    },
    {
      "name": "UpdateUserStore",
      "description": "更新用户目录",
      "status": "online",
      "parameters": [
        {
          "name": "UserPoolId",
          "type": "string",
          "required": true,
          "description": "用户池ID",
          "example": "2c3aca3b****************a7efe88e"
        },
        {
          "name": "UserPoolName",
          "type": "string",
          "required": false,
          "description": "用户池名字",
          "example": "目录1"
        },
        {
          "name": "UserPoolDesc",
          "type": "string",
          "required": false,
          "description": "用户池描述",
          "example": "管理应用和用户"
        },
        {
          "name": "UserPoolLogo",
          "type": "string",
          "required": false,
          "description": "用户池logo",
          "example": "https://**.com/***b.png"
        }
      ],
      "required": [
        "UserPoolId"
      ]
    }
  ]
}