@cloudbase/manager-node 5.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cloudbase-manager-node/.claude/settings.local.json +9 -0
- package/cloudbase-manager-node/.editorconfig +8 -0
- package/cloudbase-manager-node/.eslintignore +3 -0
- package/cloudbase-manager-node/.eslintrc.js +27 -0
- package/cloudbase-manager-node/.prettierrc.js +31 -0
- package/cloudbase-manager-node/CHANGELOG.md +109 -0
- package/cloudbase-manager-node/LICENSE +6 -0
- package/cloudbase-manager-node/README.md +46 -0
- package/cloudbase-manager-node/jest.config.js +18 -0
- package/cloudbase-manager-node/package.json +70 -0
- package/cloudbase-manager-node/scripts/link.js +98 -0
- package/cloudbase-manager-node/tsconfig.json +19 -0
- package/cloudbase-manager-node/tsconfig.test.json +14 -0
- package/lib/env/index.js +135 -1
- package/lib/function/index.js +20 -14
- package/package.json +1 -1
- package/types/env/index.d.ts +586 -1
- package/types/function/index.d.ts +5 -4
package/types/env/index.d.ts
CHANGED
|
@@ -65,10 +65,497 @@ interface IInitParam {
|
|
|
65
65
|
Channel?: string;
|
|
66
66
|
Source?: string;
|
|
67
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* 短信验证码发送配置
|
|
70
|
+
*/
|
|
71
|
+
interface IVerificationConfig {
|
|
72
|
+
/** 短信发送通道类型,如 'default' */
|
|
73
|
+
Type?: string;
|
|
74
|
+
/** 自定义 APIs 数据源名称 */
|
|
75
|
+
Name?: string;
|
|
76
|
+
/** 调用方法 */
|
|
77
|
+
Method?: string;
|
|
78
|
+
/** 每日发送限额,-1 表示不限制 */
|
|
79
|
+
SmsDayLimit?: number;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* MFA 多因子认证登录配置
|
|
83
|
+
*/
|
|
84
|
+
interface IMFALoginConfig {
|
|
85
|
+
/** MFA 因子认证,'TRUE' 或 'FALSE' */
|
|
86
|
+
On?: string;
|
|
87
|
+
/** 短信验证,'TRUE' 或 'FALSE' */
|
|
88
|
+
Sms?: string;
|
|
89
|
+
/** 邮箱验证,'TRUE' 或 'FALSE' */
|
|
90
|
+
Email?: string;
|
|
91
|
+
/** 强制绑定手机号,'TRUE' 或 'FALSE' */
|
|
92
|
+
RequiredBindPhone?: string;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* 密码修改策略配置
|
|
96
|
+
*/
|
|
97
|
+
interface IPasswordUpdateLoginConfig {
|
|
98
|
+
/** 首次登录是否强制修改密码 */
|
|
99
|
+
FirstLoginUpdate?: boolean;
|
|
100
|
+
/** 是否开启定期强制修改密码 */
|
|
101
|
+
PeriodUpdate?: boolean;
|
|
102
|
+
/** 定期修改密码的周期值 */
|
|
103
|
+
PeriodValue?: number;
|
|
104
|
+
/** 定期修改密码的周期时间单位,如 'YEAR'、'MONTH'、'WEEK' */
|
|
105
|
+
PeriodType?: string;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* DescribeLoginConfig 接口返回结果
|
|
109
|
+
*/
|
|
110
|
+
interface IDescribeLoginConfigRes {
|
|
111
|
+
/** 唯一请求 ID */
|
|
112
|
+
RequestId: string;
|
|
113
|
+
/** 是否开启邮箱登录方式 */
|
|
114
|
+
EmailLogin: boolean;
|
|
115
|
+
/** 是否开启匿名登录方式 */
|
|
116
|
+
AnonymousLogin: boolean;
|
|
117
|
+
/** 是否开启用户名密码登录方式 */
|
|
118
|
+
UserNameLogin: boolean;
|
|
119
|
+
/** 是否开启手机号短信登录方式 */
|
|
120
|
+
PhoneNumberLogin: boolean;
|
|
121
|
+
/** 短信验证码发送配置 */
|
|
122
|
+
SmsVerificationConfig: IVerificationConfig;
|
|
123
|
+
/** MFA 多因子认证登录配置 */
|
|
124
|
+
MfaConfig?: IMFALoginConfig;
|
|
125
|
+
/** 密码修改策略配置 */
|
|
126
|
+
PwdUpdateStrategy?: IPasswordUpdateLoginConfig;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* ModifyLoginConfig 请求参数
|
|
130
|
+
*/
|
|
131
|
+
interface IModifyLoginConfigParams {
|
|
132
|
+
/** 手机号短信登录开关 */
|
|
133
|
+
PhoneNumberLogin: boolean;
|
|
134
|
+
/** 邮箱登录开关 */
|
|
135
|
+
EmailLogin: boolean;
|
|
136
|
+
/** 用户名密码登录开关 */
|
|
137
|
+
UserNameLogin: boolean;
|
|
138
|
+
/** 匿名登录开关 */
|
|
139
|
+
AnonymousLogin: boolean;
|
|
140
|
+
/** 短信验证码发送配置,不传则不修改当前配置 */
|
|
141
|
+
SmsVerificationConfig?: IVerificationConfig;
|
|
142
|
+
/** MFA 多因子认证登录配置,不传则不修改当前配置 */
|
|
143
|
+
MfaConfig?: IMFALoginConfig;
|
|
144
|
+
/** 密码更新策略配置,不传则不修改当前配置 */
|
|
145
|
+
PwdUpdateStrategy?: IPasswordUpdateLoginConfig;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* ModifyLoginConfig 返回结果
|
|
149
|
+
*/
|
|
150
|
+
interface IModifyLoginConfigRes {
|
|
151
|
+
/** 请求 ID */
|
|
152
|
+
RequestId: string;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* DescribeClient 接口返回结果
|
|
156
|
+
*/
|
|
157
|
+
interface IDescribeClientRes {
|
|
158
|
+
/** 唯一请求 ID */
|
|
159
|
+
RequestId: string;
|
|
160
|
+
/** 客户端的唯一标识符(Client ID) */
|
|
161
|
+
Id: string;
|
|
162
|
+
/** 客户端的创建时间,ISO 8601 格式 */
|
|
163
|
+
CreatedAt?: string;
|
|
164
|
+
/** 客户端信息的最后修改时间,ISO 8601 格式 */
|
|
165
|
+
UpdatedAt?: string;
|
|
166
|
+
/** Refresh Token 的有效期,单位为秒 */
|
|
167
|
+
RefreshTokenExpiresIn?: number;
|
|
168
|
+
/** Access Token 的有效期,单位为秒 */
|
|
169
|
+
AccessTokenExpiresIn?: number;
|
|
170
|
+
/** 单个用户允许同时登录的最大会话数量,-1 表示不限制 */
|
|
171
|
+
MaxDevice?: number;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* ModifyClient 请求参数
|
|
175
|
+
*/
|
|
176
|
+
interface IModifyClientParams {
|
|
177
|
+
/** 客户端唯一标识符(Client ID) */
|
|
178
|
+
Id: string;
|
|
179
|
+
/** Refresh Token 的有效期,单位为秒,取值范围 1800~2592000,默认 2592000 */
|
|
180
|
+
RefreshTokenExpiresIn?: number;
|
|
181
|
+
/** Access Token 的有效期,单位为秒,最小 1800,默认 7200,应小于 RefreshTokenExpiresIn */
|
|
182
|
+
AccessTokenExpiresIn?: number;
|
|
183
|
+
/** 单个用户允许同时登录的最大会话数量,-1 不限制,0 按 User-Agent 区分,1~50 为精确限制 */
|
|
184
|
+
MaxDevice?: number;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* ModifyClient 返回结果
|
|
188
|
+
*/
|
|
189
|
+
interface IModifyClientRes {
|
|
190
|
+
/** 唯一请求 ID */
|
|
191
|
+
RequestId: string;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* 三方认证入参映射
|
|
195
|
+
* 用于非标准 OAuth 协议的参数转换。默认可为空,国内平台(如腾讯、新浪)需配置
|
|
196
|
+
*/
|
|
197
|
+
interface IProviderRequestParametersMap {
|
|
198
|
+
/** OAuth 标准协议中的 client_id 映射字段名,如微信对应 appid */
|
|
199
|
+
ClientId?: string;
|
|
200
|
+
/** OAuth 标准协议中的 client_secret 映射字段名 */
|
|
201
|
+
ClientSecret?: string;
|
|
202
|
+
/** OAuth 标准协议中的 redirect_uri 映射字段名 */
|
|
203
|
+
RedirectUri?: string;
|
|
204
|
+
/** 身份源注册用户时自动绑定的角色 ID */
|
|
205
|
+
RegisterUserRoleId?: string;
|
|
206
|
+
/** 身份源注册用户时是否自动授予许可证,'TRUE' 或 'FALSE',默认 FALSE */
|
|
207
|
+
RegisterUserAutoLicense?: string;
|
|
208
|
+
/** OAuth 获取 Token 时认证信息的请求位置:URL、Headers、Body */
|
|
209
|
+
AuthPosition?: string;
|
|
210
|
+
/** OAuth 授权模式匹配的参数字段名 */
|
|
211
|
+
GrantType?: string;
|
|
212
|
+
/** OAuth 授权模式类型,如 authorization_code、client_credentials */
|
|
213
|
+
ClientCredentials?: string;
|
|
214
|
+
/** OAuth 返回中 access_token 的映射字段名 */
|
|
215
|
+
AccessToken?: string;
|
|
216
|
+
/** OAuth 返回中 Token 有效期的映射字段名 */
|
|
217
|
+
ExpiresIn?: string;
|
|
218
|
+
/** 身份源注册用户时的用户类型:externalUser(外部用户)、internalUser(内部用户),默认 externalUser */
|
|
219
|
+
RegisterUserType?: string;
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* 三方认证出参映射
|
|
223
|
+
* 用于非标准 OAuth 协议的响应参数转换。默认可为空,国内平台(如腾讯、新浪)需配置
|
|
224
|
+
*/
|
|
225
|
+
interface IProviderResponseParametersMap {
|
|
226
|
+
/** 用户唯一标识(sub)的映射字段名,对应 OIDC 标准 sub */
|
|
227
|
+
Sub?: string;
|
|
228
|
+
/** 用户名称(name)的映射字段名,对应 OIDC 标准 name */
|
|
229
|
+
Name?: string;
|
|
230
|
+
/** 用户头像(picture)的映射字段名,需公网可访问 URL */
|
|
231
|
+
Picture?: string;
|
|
232
|
+
/** 用户登录名(username)的映射字段名,对应 OIDC 标准 preferred_username */
|
|
233
|
+
Username?: string;
|
|
234
|
+
/** 用户邮箱(email)的映射字段名,对应 OIDC 标准 email */
|
|
235
|
+
Email?: string;
|
|
236
|
+
/** 用户手机号(phone_number)的映射字段名,对应 OIDC 标准 phone_number */
|
|
237
|
+
PhoneNumber?: string;
|
|
238
|
+
/** 用户角色/分组(groups)的映射字段名,对应 OIDC 标准 groups,支持字符串数组 */
|
|
239
|
+
Groups?: string;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* 身份认证源协议连接配置
|
|
243
|
+
* 包含 OAuth 2.0 / OIDC 协议端点、客户端凭证、SAML 元数据、请求与响应参数映射等
|
|
244
|
+
*/
|
|
245
|
+
interface IProviderConfig {
|
|
246
|
+
/** 身份提供方唯一标识符(Issuer URL),仅 OIDC 类型需要,填写后自动发现端点 */
|
|
247
|
+
Issuer?: string;
|
|
248
|
+
/** JWKS 公钥地址,用于验证 ID Token 签名,仅 OIDC 类型,填 Issuer 后自动获取 */
|
|
249
|
+
JwksUri?: string;
|
|
250
|
+
/** 第三方平台注册的应用客户端 ID,OIDC/OAUTH 时必填 */
|
|
251
|
+
ClientId?: string;
|
|
252
|
+
/** 第三方平台注册的应用客户端密钥,OIDC/OAUTH 时必填 */
|
|
253
|
+
ClientSecret?: string;
|
|
254
|
+
/** OAuth 授权回调地址,需与第三方平台注册的回调地址一致 */
|
|
255
|
+
RedirectUri?: string;
|
|
256
|
+
/** 申请的权限范围,多个 scope 空格分隔,OIDC 通常至少含 openid */
|
|
257
|
+
Scope?: string;
|
|
258
|
+
/** 授权端点地址,引导用户跳转至第三方登录页面,填 Issuer 后自动获取 */
|
|
259
|
+
AuthorizationEndpoint?: string;
|
|
260
|
+
/** Token 端点地址,通过授权码换取 Token,填 Issuer 后自动获取 */
|
|
261
|
+
TokenEndpoint?: string;
|
|
262
|
+
/** 用户信息端点地址,通过 Access Token 获取用户信息,填 Issuer 后自动获取 */
|
|
263
|
+
UserinfoEndpoint?: string;
|
|
264
|
+
/** 响应类型:code(授权码)、token(隐式)、id_token,OIDC 默认 id_token,其他默认 code */
|
|
265
|
+
ResponseType?: string;
|
|
266
|
+
/** 单点退出端点地址,退出时跳转使第三方 IDP 登录态失效 */
|
|
267
|
+
SignoutEndpoint?: string;
|
|
268
|
+
/** Token 端点认证方式:CLIENT_SECRET_POST 或 CLIENT_SECRET_BASIC,默认 CLIENT_SECRET_POST */
|
|
269
|
+
TokenEndpointAuthMethod?: string;
|
|
270
|
+
/** SAML Metadata XML 内容,仅 SAML 类型,最大 10KB */
|
|
271
|
+
SamlMetadata?: string;
|
|
272
|
+
/** 请求参数映射配置,用于非标准 OAuth 协议的参数转换 */
|
|
273
|
+
RequestParametersMap?: IProviderRequestParametersMap;
|
|
274
|
+
/** 响应参数映射配置,用于非标准 OAuth 协议的响应参数转换 */
|
|
275
|
+
ResponseParametersMap?: IProviderResponseParametersMap;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* 本地化语言变体
|
|
279
|
+
*/
|
|
280
|
+
interface IMessageLocalized {
|
|
281
|
+
/** 该语言的展示文本 */
|
|
282
|
+
Message: string;
|
|
283
|
+
/** 语言标识,如 'zh'、'en'、'ko' */
|
|
284
|
+
Locale: string;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* 本地化描述
|
|
288
|
+
* 可以为每种语言配置一个字符串,比如:name,中文展示为:名字,英文展示为 name,韩文展示为 이름
|
|
289
|
+
*/
|
|
290
|
+
interface ILocalizedMessage {
|
|
291
|
+
/** 默认展示的文本 */
|
|
292
|
+
Message: string;
|
|
293
|
+
/** 针对每种语言展示的文字 */
|
|
294
|
+
Localized?: IMessageLocalized[];
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* 邮箱 SMTP 配置
|
|
298
|
+
*/
|
|
299
|
+
interface IEmailSmtpConfig {
|
|
300
|
+
/** 发件人邮箱地址,须与 SMTP 授权账号一致 */
|
|
301
|
+
SenderAddress?: string;
|
|
302
|
+
/** SMTP 服务器域名或 IP 地址,如 smtp.qq.com */
|
|
303
|
+
ServerHost?: string;
|
|
304
|
+
/** SMTP 服务器端口,465(SSL)、587(STARTTLS)、25(无加密) */
|
|
305
|
+
ServerPort?: number;
|
|
306
|
+
/** SMTP 登录账号,通常为发件人完整邮箱地址 */
|
|
307
|
+
AccountUsername?: string;
|
|
308
|
+
/** SMTP 登录密码或授权码 */
|
|
309
|
+
AccountPassword?: string;
|
|
310
|
+
/** 加密模式:AUTO、SSL、STARTSSL、NO_SSL,推荐 AUTO 或 SSL */
|
|
311
|
+
SecurityMode?: string;
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* 多语言模板
|
|
315
|
+
* 模板中必须包含 {{.VerificationCode}} 变量,
|
|
316
|
+
* 可选变量有 {{.Usage}}、{{.ExpireMinutes}}、{{.Email}}
|
|
317
|
+
*/
|
|
318
|
+
interface ILocalizedTemplate {
|
|
319
|
+
/** 中文模板 */
|
|
320
|
+
ZhCN?: string;
|
|
321
|
+
/** 英文模板 */
|
|
322
|
+
EnUS?: string;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* 邮件模板配置
|
|
326
|
+
* 模板中必须包含 {{.VerificationCode}} 变量,
|
|
327
|
+
* 可选变量有 {{.Usage}}、{{.ExpireMinutes}}、{{.Email}},
|
|
328
|
+
* 禁止包含 script、javascript、onclick、onload、iframe、link 标签及 CSS expression、CSS url() 等
|
|
329
|
+
*/
|
|
330
|
+
interface IEmailTemplateConfig {
|
|
331
|
+
/** 注册登录模板 */
|
|
332
|
+
RegisterSignIn?: ILocalizedTemplate;
|
|
333
|
+
/** 默认模板 */
|
|
334
|
+
DefaultTpl?: ILocalizedTemplate;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* 邮箱身份源专项配置(ProviderType 为 EMAIL 时有效)
|
|
338
|
+
*/
|
|
339
|
+
interface IEmailProviderConfig {
|
|
340
|
+
/** 是否采用平台默认代发,'TRUE' 或 'FALSE'。为 TRUE 时无需配置 SmtpConfig */
|
|
341
|
+
On?: string;
|
|
342
|
+
/** SMTP 配置,自有邮件服务器时填写 */
|
|
343
|
+
SmtpConfig?: IEmailSmtpConfig;
|
|
344
|
+
/** 邮件模板配置 */
|
|
345
|
+
TemplateConfig?: IEmailTemplateConfig;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* 身份认证源
|
|
349
|
+
*/
|
|
350
|
+
interface IProvider {
|
|
351
|
+
/** 身份源唯一标识,2~32 位小写字母和数字,创建后不可修改 */
|
|
352
|
+
Id: string;
|
|
353
|
+
/** 身份源安全认证配置,包含 ClientId、ClientSecret、授权端点等。不同 ProviderType 对应不同配置项 */
|
|
354
|
+
Config: IProviderConfig;
|
|
355
|
+
/** 身份源名称,支持国际化多语言配置 */
|
|
356
|
+
Name?: ILocalizedMessage;
|
|
357
|
+
/** 身份源图标 URL,建议 64×64 SVG 格式 */
|
|
358
|
+
Picture?: string;
|
|
359
|
+
/** 身份源官方主页地址 */
|
|
360
|
+
Homepage?: string;
|
|
361
|
+
/** 身份源协议类型:OAUTH、OIDC、SAML、CUSTOM、EMAIL */
|
|
362
|
+
ProviderType?: string;
|
|
363
|
+
/** 控制第三方身份源登录时是否自动注册系统用户,'TRUE'、'FALSE'、'UNSPECIFIED' */
|
|
364
|
+
AutoSignUpWithProviderUser?: string;
|
|
365
|
+
/** 身份源启用状态,'TRUE' 或 'FALSE' */
|
|
366
|
+
On?: string;
|
|
367
|
+
/** 身份源描述,支持国际化多语言配置 */
|
|
368
|
+
Description?: ILocalizedMessage;
|
|
369
|
+
/** 是否开启信息透传模式,'TRUE' 或 'FALSE' */
|
|
370
|
+
TransparentMode?: string;
|
|
371
|
+
/** 是否复用第三方身份源用户标识作为平台用户 ID,'TRUE' 或 'FALSE' */
|
|
372
|
+
ReuseUserId?: string;
|
|
373
|
+
/** 邮箱身份源专项配置,仅 ProviderType 为 EMAIL 时有效 */
|
|
374
|
+
EmailConfig?: IEmailProviderConfig;
|
|
375
|
+
/** 是否开启邮箱自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED' */
|
|
376
|
+
AutoSignInWhenEmailMatch?: string;
|
|
377
|
+
/** 是否开启手机号自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED',默认为 TRUE */
|
|
378
|
+
AutoSignInWhenPhoneNumberMatch?: string;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* GetProviders 返回结果
|
|
382
|
+
*/
|
|
383
|
+
interface IGetProvidersRes {
|
|
384
|
+
/** 唯一请求 ID */
|
|
385
|
+
RequestId: string;
|
|
386
|
+
/** 认证源总数 */
|
|
387
|
+
Total?: number;
|
|
388
|
+
/** 三方认证源列表 */
|
|
389
|
+
Data?: IProvider[];
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* ModifyProvider 请求参数
|
|
393
|
+
*/
|
|
394
|
+
interface IModifyProviderParams {
|
|
395
|
+
/** 身份源唯一标识符,2~32 位小写字母和数字 */
|
|
396
|
+
Id: string;
|
|
397
|
+
/** 身份源显示名称,支持国际化 */
|
|
398
|
+
Name?: ILocalizedMessage;
|
|
399
|
+
/** 身份源图标 URL,建议 64×64 SVG */
|
|
400
|
+
Picture?: string;
|
|
401
|
+
/** 身份源官方主页地址 */
|
|
402
|
+
Homepage?: string;
|
|
403
|
+
/** 身份源协议类型:OAUTH、OIDC、SAML、WX_MICRO_APP、WX_QRCODE_MICRO_APP、
|
|
404
|
+
* WX_CLOUDBASE_MICRO_APP、WX_MP、WX_OPEN、WX_WORK_INTERNAL、WX_WORK_AGENT、
|
|
405
|
+
* WX_WORK_THIRD_PARTY、WX_WORK_THIRD_PARTY_ASSOCIATION、CUSTOM、EMAIL */
|
|
406
|
+
ProviderType?: string;
|
|
407
|
+
/** 身份认证源协议连接配置 */
|
|
408
|
+
Config?: IProviderConfig;
|
|
409
|
+
/** 是否开启透传模式,'TRUE' 或 'FALSE',开启后 ReuseUserId 强制 TRUE,AutoSignUpWithProviderUser 强制 FALSE */
|
|
410
|
+
TransparentMode?: string;
|
|
411
|
+
/** 身份源启用状态,'TRUE'、'FALSE'、'UNSPECIFIED',默认 TRUE */
|
|
412
|
+
On?: string;
|
|
413
|
+
/** 身份源描述,支持国际化 */
|
|
414
|
+
Description?: ILocalizedMessage;
|
|
415
|
+
/** 是否复用第三方用户 ID 作为平台用户 ID,'TRUE'、'FALSE'、'UNSPECIFIED' */
|
|
416
|
+
ReuseUserId?: string;
|
|
417
|
+
/** 控制第三方身份源登录时是否自动注册系统用户,'TRUE'、'FALSE'、'UNSPECIFIED' */
|
|
418
|
+
AutoSignUpWithProviderUser?: string;
|
|
419
|
+
/** 邮箱身份源专项配置,仅 Id 为 email 时有效 */
|
|
420
|
+
EmailConfig?: IEmailProviderConfig;
|
|
421
|
+
/** 是否开启邮箱自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED',默认 FALSE */
|
|
422
|
+
AutoSignInWhenEmailMatch?: string;
|
|
423
|
+
/** 是否开启手机号自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED',默认等同 TRUE */
|
|
424
|
+
AutoSignInWhenPhoneNumberMatch?: string;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* ModifyProvider 返回结果
|
|
428
|
+
*/
|
|
429
|
+
interface IModifyProviderRes {
|
|
430
|
+
/** 唯一请求 ID */
|
|
431
|
+
RequestId: string;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* DeleteProvider 返回结果
|
|
435
|
+
*/
|
|
436
|
+
interface IDeleteProviderRes {
|
|
437
|
+
/** 唯一请求 ID */
|
|
438
|
+
RequestId: string;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* AddProvider 请求参数
|
|
442
|
+
*/
|
|
443
|
+
interface IAddProviderParams {
|
|
444
|
+
/** 身份源显示名称,支持国际化,必填 */
|
|
445
|
+
Name: ILocalizedMessage;
|
|
446
|
+
/** 身份源协议类型,必填。可选值:OAUTH、OIDC、SAML、WX_MICRO_APP、WX_QRCODE_MICRO_APP、
|
|
447
|
+
* WX_CLOUDBASE_MICRO_APP、WX_MP、WX_OPEN、WX_WORK_INTERNAL、WX_WORK_AGENT、
|
|
448
|
+
* WX_WORK_THIRD_PARTY、WX_WORK_THIRD_PARTY_ASSOCIATION、CUSTOM、EMAIL */
|
|
449
|
+
ProviderType: string;
|
|
450
|
+
/** 身份源唯一标识符,2~32 位小写字母和数字,不填则系统自动生成 */
|
|
451
|
+
Id?: string;
|
|
452
|
+
/** 身份源图标 URL,建议 64×64 SVG */
|
|
453
|
+
Picture?: string;
|
|
454
|
+
/** 身份源官方主页地址 */
|
|
455
|
+
Homepage?: string;
|
|
456
|
+
/** 身份认证源协议连接配置 */
|
|
457
|
+
Config?: IProviderConfig;
|
|
458
|
+
/** 是否开启透传模式,'TRUE'、'FALSE'、'UNSPECIFIED',默认 FALSE */
|
|
459
|
+
TransparentMode?: string;
|
|
460
|
+
/** 身份源启用状态,'TRUE'、'FALSE'、'UNSPECIFIED',默认 TRUE */
|
|
461
|
+
On?: string;
|
|
462
|
+
/** 身份源描述,支持国际化 */
|
|
463
|
+
Description?: ILocalizedMessage;
|
|
464
|
+
/** 是否复用第三方用户 ID 作为平台用户 ID,'TRUE'、'FALSE'、'UNSPECIFIED' */
|
|
465
|
+
ReuseUserId?: string;
|
|
466
|
+
/** 是否开启邮箱自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED',默认 FALSE */
|
|
467
|
+
AutoSignInWhenEmailMatch?: string;
|
|
468
|
+
/** 是否开启手机号自动关联登录,'TRUE'、'FALSE'、'UNSPECIFIED',默认等同 TRUE */
|
|
469
|
+
AutoSignInWhenPhoneNumberMatch?: string;
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* AddProvider 返回结果
|
|
473
|
+
*/
|
|
474
|
+
interface IAddProviderRes {
|
|
475
|
+
/** 唯一请求 ID */
|
|
476
|
+
RequestId: string;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* CreateApiKey 请求参数
|
|
480
|
+
*/
|
|
481
|
+
interface ICreateApiKeyParams {
|
|
482
|
+
/** 密钥类型:api_key、publish_key */
|
|
483
|
+
KeyType: 'api_key' | 'publish_key';
|
|
484
|
+
/** 密钥自定义名称,建议填写描述性名称,如 server-prod */
|
|
485
|
+
KeyName?: string;
|
|
486
|
+
/** 密钥有效期,单位秒,最短 7200 秒。0 或不设置表示永不过期 */
|
|
487
|
+
ExpireIn?: number;
|
|
488
|
+
}
|
|
489
|
+
/**
|
|
490
|
+
* CreateApiKey 返回结果
|
|
491
|
+
*/
|
|
492
|
+
interface ICreateApiKeyRes {
|
|
493
|
+
/** 唯一请求 ID */
|
|
494
|
+
RequestId: string;
|
|
495
|
+
/** API Key 唯一标识符,用于后续查询、修改、删除操作 */
|
|
496
|
+
KeyId: string;
|
|
497
|
+
/** API Key 名称 */
|
|
498
|
+
Name: string;
|
|
499
|
+
/** API Key 令牌值(JWT 格式),仅在创建时返回完整明文,请妥善保存 */
|
|
500
|
+
ApiKey?: string;
|
|
501
|
+
/** 过期时间,ISO 8601 格式。api_key 未设有效期则不返回,publish_key 固定 2099 年 */
|
|
502
|
+
ExpireAt?: string;
|
|
503
|
+
/** 创建时间,ISO 8601 格式 */
|
|
504
|
+
CreateAt?: string;
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* DeleteApiKey 返回结果
|
|
508
|
+
*/
|
|
509
|
+
interface IDeleteApiKeyRes {
|
|
510
|
+
/** 唯一请求 ID */
|
|
511
|
+
RequestId: string;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* API Key 访问凭证信息
|
|
515
|
+
* 描述云开发环境下 API Key 的完整信息,包括标识符、名称、令牌值、创建时间和过期时间。
|
|
516
|
+
* 支持两种类型:api_key(服务端管理员访问凭证,可设置有效期,单个环境最多 5 个)
|
|
517
|
+
* 和 publish_key(前端匿名访问凭证,固定有效期,每个环境仅保留一个)。
|
|
518
|
+
* 注意:令牌值(ApiKey 字段)仅在创建时返回完整明文,列表查询时将进行脱敏处理。
|
|
519
|
+
*/
|
|
520
|
+
interface IApiKeyToken {
|
|
521
|
+
/** API Key 的唯一标识符,由系统基于 UUID 自动生成的 Base64 URL 编码字符串 */
|
|
522
|
+
KeyId?: string;
|
|
523
|
+
/** API Key 的名称,创建时传入的 KeyName 参数值。publish_key 类型固定为 publish_key */
|
|
524
|
+
Name?: string;
|
|
525
|
+
/** API Key 的令牌值(JWT 格式),仅在创建时返回完整明文,列表查询时脱敏处理 */
|
|
526
|
+
ApiKey?: string | null;
|
|
527
|
+
/** API Key 的过期时间,ISO 8601 格式。api_key 未设有效期则不返回,publish_key 固定约 2099 年 */
|
|
528
|
+
ExpireAt?: string | null;
|
|
529
|
+
/** API Key 的创建时间,ISO 8601 格式。publish_key 返回首次创建时间 */
|
|
530
|
+
CreateAt?: string | null;
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* DescribeApiKeyList 请求参数
|
|
534
|
+
*/
|
|
535
|
+
interface IDescribeApiKeyListParams {
|
|
536
|
+
/** 密钥类型过滤:api_key 或 publish_key,默认 api_key */
|
|
537
|
+
KeyType?: 'api_key' | 'publish_key';
|
|
538
|
+
/** 分页页码,从 1 开始,默认 1 */
|
|
539
|
+
PageNumber?: number;
|
|
540
|
+
/** 每页条数,默认系统值 */
|
|
541
|
+
PageSize?: number;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* DescribeApiKeyList 返回结果
|
|
545
|
+
*/
|
|
546
|
+
interface IDescribeApiKeyListRes {
|
|
547
|
+
/** 唯一请求 ID */
|
|
548
|
+
RequestId: string;
|
|
549
|
+
/** API Key 列表 */
|
|
550
|
+
Data?: IApiKeyToken[];
|
|
551
|
+
/** 总数 */
|
|
552
|
+
Total?: number;
|
|
553
|
+
}
|
|
68
554
|
export declare class EnvService {
|
|
69
555
|
private environment;
|
|
70
556
|
private envId;
|
|
71
557
|
private cloudService;
|
|
558
|
+
private tcbService;
|
|
72
559
|
private envType?;
|
|
73
560
|
private commonService;
|
|
74
561
|
private billingService;
|
|
@@ -150,16 +637,26 @@ export declare class EnvService {
|
|
|
150
637
|
updateEnvInfo(alias: string): Promise<IResponseInfo>;
|
|
151
638
|
/**
|
|
152
639
|
* 拉取登录配置列表
|
|
153
|
-
* @deprecated 请使用
|
|
640
|
+
* @deprecated 请使用 getLoginConfig 代替
|
|
154
641
|
* @returns {Promise<IEnvLoginConfigRes>}
|
|
155
642
|
*/
|
|
156
643
|
getLoginConfigList(): Promise<IEnvLoginConfigRes>;
|
|
157
644
|
/**
|
|
158
645
|
* 拉取登录配置列表
|
|
646
|
+
* @deprecated 该方法已废弃,请使用 getLoginConfig 代替
|
|
159
647
|
*/
|
|
160
648
|
getLoginConfigListV2(): Promise<ILoginStrategy>;
|
|
649
|
+
/**
|
|
650
|
+
* 获取登录策略配置
|
|
651
|
+
* 查询指定云开发环境的登录策略配置,包括手机号短信登录、邮箱登录、
|
|
652
|
+
* 用户名密码登录和匿名登录方式的开启状态,同时包含短信验证码发送通道、
|
|
653
|
+
* MFA 多因子认证和密码的更新策略。
|
|
654
|
+
* @returns {Promise<IDescribeLoginConfigRes>}
|
|
655
|
+
*/
|
|
656
|
+
getLoginConfig(): Promise<IDescribeLoginConfigRes>;
|
|
161
657
|
/**
|
|
162
658
|
* 创建登录方式
|
|
659
|
+
* @deprecated 该方法已废弃
|
|
163
660
|
* 'WECHAT-OPEN':微信开放平台
|
|
164
661
|
* 'WECHAT-PUBLIC':微信公众平台
|
|
165
662
|
* @param {('WECHAT-OPEN' | 'WECHAT-PUBLIC')} platform 'WECHAT-OPEN' | 'WECHAT-PUBLIC'
|
|
@@ -170,6 +667,7 @@ export declare class EnvService {
|
|
|
170
667
|
createLoginConfig(platform: 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'QQ' | 'ANONYMOUS' | 'USERNAME', appId: string, appSecret?: string): Promise<IResponseInfo>;
|
|
171
668
|
/**
|
|
172
669
|
* 更新登录方式配置
|
|
670
|
+
* @deprecated 该方法已废弃,请使用 modifyLoginConfig 代替
|
|
173
671
|
* @param {string} configId 配置 Id,从配置列表中获取
|
|
174
672
|
* @param {string} [status='ENABLE'] 是否启用 'ENABLE', 'DISABLE' ,可选
|
|
175
673
|
* @param {string} [appId=''] 微信 appId,可选
|
|
@@ -180,10 +678,97 @@ export declare class EnvService {
|
|
|
180
678
|
updateLoginConfig(configId: string, status?: string, appId?: string, appSecret?: string): Promise<IResponseInfo>;
|
|
181
679
|
/**
|
|
182
680
|
* 更新登录方式配置
|
|
681
|
+
* @deprecated 该方法已废弃,请使用 modifyLoginConfig 代替
|
|
183
682
|
* @param {IModifyLoginStrategy} options
|
|
184
683
|
* @returns {Promise<boolean>}
|
|
185
684
|
*/
|
|
186
685
|
updateLoginConfigV2(options: IModifyLoginStrategy): Promise<boolean>;
|
|
686
|
+
/**
|
|
687
|
+
* 修改登录策略配置
|
|
688
|
+
* 修改指定云开发环境的登录策略配置。支持开启或关闭手机号短信登录、邮箱登录、
|
|
689
|
+
* 用户名密码登录和匿名登录,同时可配置短信验证码发送通道、MFA 多因子认证和密码更新策略。
|
|
690
|
+
* 修改后立即生效,影响该环境下所有终端用户的登录行为。
|
|
691
|
+
* @param {IModifyLoginConfigParams} options 修改参数
|
|
692
|
+
* @returns {Promise<IModifyLoginConfigRes>}
|
|
693
|
+
*/
|
|
694
|
+
modifyLoginConfig(options: IModifyLoginConfigParams): Promise<IModifyLoginConfigRes>;
|
|
695
|
+
/**
|
|
696
|
+
* 查询应用客户端详情
|
|
697
|
+
* 获取指定云开发环境下某个客户端的配置信息,包括 OAuth 凭证、Token 有效期、会话控制策略等。
|
|
698
|
+
* 当客户端 ID 等于环境 ID 时,返回该环境的默认客户端配置。
|
|
699
|
+
* @param {string} Id 客户端唯一标识符(Client ID),一般使用环境 ID
|
|
700
|
+
* @returns {Promise<IDescribeClientRes>}
|
|
701
|
+
*/
|
|
702
|
+
describeClient(Id: string): Promise<IDescribeClientRes>;
|
|
703
|
+
/**
|
|
704
|
+
* 修改应用客户端配置
|
|
705
|
+
* 采用增量更新策略,仅更新请求中传入的非空字段,未传入的字段保持原值不变。
|
|
706
|
+
* 支持修改 Token 有效期、会话控制策略等配置。
|
|
707
|
+
* 当客户端 ID 等于环境 ID 且客户端尚未创建时,将自动创建默认客户端配置。
|
|
708
|
+
* @param {IModifyClientParams} options 修改参数
|
|
709
|
+
* @returns {Promise<IModifyClientRes>}
|
|
710
|
+
*/
|
|
711
|
+
modifyClient(options: IModifyClientParams): Promise<IModifyClientRes>;
|
|
712
|
+
/**
|
|
713
|
+
* 获取三方认证源列表
|
|
714
|
+
* 查询指定云开发环境下的身份认证源列表,包括第三方登录(OAuth、OIDC、SAML)、
|
|
715
|
+
* 微信小程序登录、自定义登录和邮箱登录等。
|
|
716
|
+
* 若自定义登录或邮箱登录的身份源尚未创建,接口会自动追加一个默认关闭状态的记录。
|
|
717
|
+
* @returns {Promise<IGetProvidersRes>}
|
|
718
|
+
*/
|
|
719
|
+
getProviders(): Promise<IGetProvidersRes>;
|
|
720
|
+
/**
|
|
721
|
+
* 修改身份认证源
|
|
722
|
+
* 更新已有身份认证源的配置信息,支持修改基本信息、协议连接配置、登录行为控制及启用状态。
|
|
723
|
+
* 采用增量更新策略,仅更新传入的字段,未传入的字段保持原值。
|
|
724
|
+
* OIDC 类型修改 Issuer 后将自动通过 Discovery 重新获取端点配置。
|
|
725
|
+
* 若 CUSTOM 或 EMAIL 身份源尚不存在,调用时将自动创建。
|
|
726
|
+
* @param {IModifyProviderParams} options 修改参数
|
|
727
|
+
* @returns {Promise<IModifyProviderRes>}
|
|
728
|
+
*/
|
|
729
|
+
modifyProvider(options: IModifyProviderParams): Promise<IModifyProviderRes>;
|
|
730
|
+
/**
|
|
731
|
+
* 删除第三方认证源
|
|
732
|
+
* @param {string} Id 认证源 ID,2~32 位小写英文字母或数字,如 'github'
|
|
733
|
+
* @returns {Promise<IDeleteProviderRes>}
|
|
734
|
+
*/
|
|
735
|
+
deleteProvider(Id: string): Promise<IDeleteProviderRes>;
|
|
736
|
+
/**
|
|
737
|
+
* 添加身份认证源
|
|
738
|
+
* 在指定云开发环境下创建新的身份认证源,支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议,
|
|
739
|
+
* 以及自定义登录和邮箱登录等多种认证方式。若身份源 ID 已存在将返回错误。
|
|
740
|
+
* 限制:一个环境最大可允许加入 20 个认证源。
|
|
741
|
+
* @param {IAddProviderParams} options 添加参数
|
|
742
|
+
* @returns {Promise<IAddProviderRes>}
|
|
743
|
+
*/
|
|
744
|
+
addProvider(options: IAddProviderParams): Promise<IAddProviderRes>;
|
|
745
|
+
/**
|
|
746
|
+
* 创建 API Key
|
|
747
|
+
* 在指定云开发环境下创建 API Key 访问凭证。支持两种类型:
|
|
748
|
+
* - api_key:服务端管理员访问凭证,可设置有效期
|
|
749
|
+
* - publish_key:前端匿名访问凭证,固定有效期
|
|
750
|
+
* 创建成功后返回 API Key 明文 Token,该值仅在创建时返回一次,请妥善保存。
|
|
751
|
+
* @param {ICreateApiKeyParams} options 创建参数
|
|
752
|
+
* @returns {Promise<ICreateApiKeyRes>}
|
|
753
|
+
*/
|
|
754
|
+
createApiKey(options: ICreateApiKeyParams): Promise<ICreateApiKeyRes>;
|
|
755
|
+
/**
|
|
756
|
+
* 删除 API Key
|
|
757
|
+
* 删除指定云开发环境下的某个 API Key 服务端访问凭证。
|
|
758
|
+
* 删除后该 Key 对应的 Token 将被吊销,已使用该 Key 发起的请求将失败。
|
|
759
|
+
* 该操作具有幂等性,若指定的 API Key 不存在则直接返回成功。
|
|
760
|
+
* @param {string} KeyId 密钥唯一标识符,可通过查询密钥列表接口获取
|
|
761
|
+
* @returns {Promise<IDeleteApiKeyRes>}
|
|
762
|
+
*/
|
|
763
|
+
deleteApiKey(KeyId: string): Promise<IDeleteApiKeyRes>;
|
|
764
|
+
/**
|
|
765
|
+
* 查询 API Key 列表
|
|
766
|
+
* 分页查询指定云开发环境下的 API Key 访问凭证列表,支持按类型过滤。
|
|
767
|
+
* api_key 类型的令牌值脱敏处理,publish_key 类型返回完整明文。
|
|
768
|
+
* @param {IDescribeApiKeyListParams} options 查询参数
|
|
769
|
+
* @returns {Promise<IDescribeApiKeyListRes>}
|
|
770
|
+
*/
|
|
771
|
+
describeApiKeyList(options?: IDescribeApiKeyListParams): Promise<IDescribeApiKeyListRes>;
|
|
187
772
|
createCustomLoginKeys(): Promise<{
|
|
188
773
|
PrivateKey: string;
|
|
189
774
|
KeyID: string;
|
|
@@ -504,17 +504,18 @@ export declare class FunctionService {
|
|
|
504
504
|
*/
|
|
505
505
|
getFunctionAlias(params: IGetFunctionAlias): Promise<IGetFunctionAliasRes>;
|
|
506
506
|
/**
|
|
507
|
-
* 通过
|
|
507
|
+
* 通过 SCF COS 上传方式(通过 GetTempCosInfo + COS SDK 上传)
|
|
508
508
|
* 返回 TempCosObjectName 用于创建/更新函数
|
|
509
509
|
*/
|
|
510
|
-
|
|
510
|
+
uploadFunctionZipToCos(options: IFunctionCode, installDependency: 'TRUE' | 'FALSE'): Promise<{
|
|
511
511
|
Key: string;
|
|
512
512
|
}>;
|
|
513
513
|
/**
|
|
514
|
-
*
|
|
514
|
+
* 旧的 COS 上传方式(通过 DescribeBuildServiceCosInfo + PUT 上传)
|
|
515
515
|
* 返回 CosTimestamp 用于创建/更新函数
|
|
516
|
+
* @deprecated 请使用 uploadFunctionZipToCos 代替
|
|
516
517
|
*/
|
|
517
|
-
|
|
518
|
+
uploadFunctionZipToCosLegacy(options: IFunctionCode, installDependency: 'TRUE' | 'FALSE'): Promise<{
|
|
518
519
|
UnixTimestamp: string;
|
|
519
520
|
}>;
|
|
520
521
|
getCodeParams(options: IFunctionCode, installDependency: 'TRUE' | 'FALSE'): Promise<{
|