数据类型
Model对象定义
AgentDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
Agent ID |
| bceDomainId |
String |
BCE 账户 ID |
| bceUserId |
String |
BCE 用户 ID |
| name |
String |
Agent 名称 |
| description |
String |
Agent 描述 |
| extra |
String |
扩展信息 |
| allowedResourceOauth2ReturnUrls |
List |
OAuth2 回调 URL 白名单列表 |
| createdAt |
DateTime |
创建时间 |
| updatedAt |
DateTime |
更新时间 |
CredentialProviderDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
凭证提供方 ID |
| bceDomainId |
String |
BCE 账户 ID |
| bceUserId |
String |
BCE 用户 ID |
| name |
String |
名称 |
| type |
String |
凭证类型:API_KEY / OAUTH2 / STS |
| desc |
String |
描述 |
| credential |
CredentialConfig |
凭证配置内容(随 type 不同,见 CredentialConfig;敏感值为 KMS Secret ID,非明文) |
| createdAt |
DateTime |
创建时间 |
| updatedAt |
DateTime |
更新时间 |
CredentialConfig
| 参数名称 |
类型 |
描述 |
| apiKey |
String |
【API_KEY】API Key 的 KMS Secret ID(非明文) |
| configType |
String |
【OAUTH2】配置模式:AUTO_DISCOVERY / MANUAL |
| provider |
String |
【OAUTH2】提供方:CUSTOM / DINGTALK / FEISHU,默认 CUSTOM |
| discoveryUrl |
String |
【OAUTH2】OIDC Discovery URL(AUTO_DISCOVERY 模式) |
| issuer |
String |
【OAUTH2】签发者 |
| authorizationEndpoint |
String |
【OAUTH2】授权端点 |
| tokenEndpoint |
String |
【OAUTH2】Token 端点 |
| userinfoEndpoint |
String |
【OAUTH2】UserInfo 端点 |
| jwksUri |
String |
【OAUTH2】JWKS 端点 |
| clientId |
String |
【OAUTH2】client_id |
| clientSecret |
String |
【OAUTH2】client_secret 的 KMS Secret ID(非明文) |
| scopes |
String |
【OAUTH2】scope 列表,逗号分隔 |
| redirectUri |
String |
【OAUTH2】回调地址(系统生成) |
| tokenEncryptionKeyId |
String |
【OAUTH2】Token Vault 加密密钥的 KMS Secret ID(系统生成) |
| roleArn |
String |
【STS】角色 ARN |
| externalId |
String |
【STS】外部 ID(可选) |
| durationSeconds |
Integer |
【STS】临时凭证有效期(秒) |
说明:credential 为多态结构,实际包含字段取决于凭证类型 type(API_KEY / OAUTH2 / STS),上表按类型用【】标注。
WorkloadAccessTokenDTO
| 参数名称 |
类型 |
描述 |
| token |
String |
WAT 令牌(格式:wat-v1.) |
| expireAt |
DateTime |
过期时间(ISO 8601) |
ResourceCredentialDTO
| 参数名称 |
类型 |
描述 |
| type |
String |
凭证类型(API_KEY) |
| name |
String |
凭证提供方名称 |
| credential |
Object |
凭证内容 |
| credential.apiKey |
String |
API Key 明文值 |
| expireAt |
DateTime |
凭证缓存过期时间(ISO 8601) |
OAuth2CredentialResponse
| 参数名称 |
类型 |
描述 |
| accessToken |
String |
OAuth2 access token(token 就绪时返回,与 sessionStatus 互斥) |
| authorizationUrl |
String |
授权 URL(仅首次发起时返回) |
| sessionUri |
String |
会话标识(轮询用) |
| sessionStatus |
String |
会话状态:IN_PROGRESS / FAILED |
WorkloadAccessToken
| 参数名称 |
类型 |
描述 |
| version |
Integer |
令牌版本 |
| id |
String |
令牌 ID |
| createdAt |
Long |
创建时间戳(毫秒) |
| expireAt |
Long |
过期时间戳(毫秒) |
| scope |
List |
权限范围 |
| workload |
Object |
工作负载上下文 |
| workload.agentId |
String |
Agent ID |
| workload.bceDomainId |
String |
BCE 账户 ID |
| workload.bceUserId |
String |
BCE 用户 ID |
| user |
Object |
用户上下文(可选) |
| user.endUserId |
String |
终端用户 ID |
| user.sessionId |
String |
会话 ID |
UserPoolDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
用户池 ID |
| domainId |
String |
BCE 账户 ID |
| name |
String |
用户池名称 |
| description |
String |
用户池描述 |
| userCount |
Integer |
用户池内用户数量 |
| clientCount |
Integer |
用户池内 OAuth2 客户端数量 |
| idpCount |
Integer |
用户池内 IdP 配置数量 |
| callbackUrl |
String |
统一 IdP 回调地址 |
| discoveryUrl |
String |
OIDC Discovery URL |
| authorizationEndpoint |
String |
授权端点 |
| tokenEndpoint |
String |
Token 端点 |
| userinfoEndpoint |
String |
UserInfo 端点 |
| jwksUrl |
String |
JWKS 端点 |
| enabled |
Boolean |
是否启用 |
| createdAt |
DateTime |
创建时间 |
UserPoolUserDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
用户 ID |
| username |
String |
用户名 |
| displayName |
String |
显示名称 |
| description |
String |
描述 |
| source |
String |
来源:MANUAL / AUTO |
| hasPassword |
Boolean |
是否已设置密码 |
| createdAt |
DateTime |
创建时间 |
UserPoolIdpConfigDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
IdP 配置 ID |
| name |
String |
显示名称 |
| idpType |
String |
协议类型:OAUTH2 / OIDC / CAS |
| idpProvider |
String |
OAuth2 提供方:CUSTOM / DINGTALK / FEISHU;非 OAuth2 为 null |
| clientId |
String |
OAuth2 client_id |
| clientSecret |
String |
client_secret(get 返回明文,list 不返回) |
| discoveryUrl |
String |
Discovery URL |
| authorizationEndpoint |
String |
授权端点 |
| tokenEndpoint |
String |
Token 端点 |
| userinfoEndpoint |
String |
UserInfo 端点 |
| scopes |
List |
请求的 scope |
| userIdClaim |
String |
用户 ID 映射字段 |
| displayNameClaim |
String |
显示名称映射字段 |
| autoCreateUser |
Boolean |
是否自动创建用户 |
| enabled |
Boolean |
是否启用 |
| callbackUrl |
String |
统一 IdP 回调地址(运行时派生) |
| createdAt |
DateTime |
创建时间 |
UserPoolOAuth2ClientDTO
| 参数名称 |
类型 |
描述 |
| id |
String |
客户端记录 ID |
| clientId |
String |
OAuth2 client_id |
| clientSecret |
String |
client_secret(get 返回明文,list 不返回) |
| name |
String |
客户端名称 |
| description |
String |
描述 |
| clientType |
String |
客户端类型:WEB_APP / SPA / M2M |
| redirectUris |
List |
回调地址白名单 |
| grantTypes |
List |
授权类型 |
| scopes |
List |
允许的 scope |
| accessTokenTtl |
Integer |
access_token 有效期(秒) |
| refreshTokenTtl |
Integer |
refresh_token 有效期(秒) |
| enabled |
Boolean |
是否启用 |
| loginUrl |
String |
拼装好的 OAuth2 authorize 链接 |
| createdAt |
DateTime |
创建时间 |
CreateOAuth2ClientResponse
| 参数名称 |
类型 |
描述 |
| id |
String |
客户端记录 ID |
| clientId |
String |
系统生成的 OAuth2 client_id |
| clientSecret |
String |
client_secret 明文(仅此一次) |
| name |
String |
客户端名称 |
| clientType |
String |
客户端类型:WEB_APP / SPA / M2M |
| createdAt |
DateTime |
创建时间 |
OAuth2TokenResponse
| 参数名称 |
类型 |
描述 |
| access_token |
String |
JWT 格式的 access token(始终返回) |
| id_token |
String |
JWT 格式的 ID token(scope 含 openid 时返回) |
| refresh_token |
String |
JWT 格式的 refresh token(scope 含 offline_access 且客户端 grantTypes 含 refresh_token 时返回,滚动签发) |
| token_type |
String |
固定 Bearer(始终返回) |
| expires_in |
Integer |
access_token 有效期(秒),始终返回 |
| refresh_expires_in |
Integer |
refresh_token 有效期(秒),有 refresh_token 时返回 |