PrepareIdentityProviderSCIM - 准备 SCIM 接收配置和凭据
准备 SCIM 接收配置,返回预配 URL 和凭据摘要;没有可用凭据时签发 Token,仅本次返回明文,不自动开启 AC 用户同步。
接口说明
功能与前提\n 要求可用 CustomSSO 共享用户池;不依赖 SAML Metadata,也不受 SAML 更新中/更新失败状态锁。同步调用 AgentIdentity 开启 SCIM 接收,读取配置及凭据列表。接收已启用时复用现有配置;重复初始化不重复创建有效凭据,也不自动开启用户同步。如果已有状态 Enabled 且尚未过期的凭据,返回其摘要且 token=null;没有可用凭据时创建一枚并仅当次返回 Token。已有无效或过期凭据不会被自动删除,仍可能触发上游最多两枚凭据的限制。\nprepare 有开启接收和可能签发凭据的副作用,但不设置 AC syncEnabled、不启动首次导入,也不代表外部预配连接测试通过。用户将 baseUrl 和本次 Token 配置到外部预配系统后,再调用 UpdateIdentityProviderSCIM 确认开启同步。不能重取已有 Token;响应丢失时先查询凭据列表,不自动重复签发。Token 不应记录到日志或持久化前端缓存。\n\n## 请求与示例\nPOST /workspaces/{workspaceId}/scim-provisioning/prepare\n 调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\ntext\nPOST /workspaces/ws-example/scim-provisioning/prepare\n 无业务请求体。\n\n\n## 返回示例\njson\n{\n "data": {\n "configuration": {\n "status": "Enabled",\n "baseUrl": "https://example.com/scim/v2"\n },\n "credential": {\n "credentialId": "credential-example",\n "status": "Enabled",\n "expireTime": "<上游返回的到期时间>"\n },\n "token": "<仅本次新签发的 Token;已有可用凭据时为 null>"\n }\n}\n\n\n## 错误与处理\n 错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 LimitExceeded.ScimCredential:已达到最多两枚凭据,需用户明确删除一枚后重试;不自动删除、轮换或扩容。400 InvalidParameter:共享池不可用。此调用可能已开启上游接收再因签发失败报错,错误不代表操作已自动回滚。\n\n## 调用关系与使用边界\n 共享池通过 CreateIdentityProvider 的 identityProviderType=CustomSSO 创建;不需要配置 SAML。若复用了已有凭据而 token=null,应使用用户已经保存的 Token,不能把空值配置到外部系统;Token 丢失时先 ListIdentityProviderSCIMCredentials 核查,再显式 CreateIdentityProviderSCIMCredential 签发;达到两枚上限时由用户确认后删除不再使用的一枚。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:PrepareIdentityProviderSCIM |
create |
*IdentityProvider
|
无 | 无 |
请求语法
POST /workspaces/{workspaceId}/scim-provisioning/prepare HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
必填,目标 Workspace 的标识;请求地域需与目标 Workspace 一致。 |
ws-example |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| requestId |
string |
用于关联本次调用与排障,失败时请保留。 |
request-example |
| message |
string |
请求受理或错误消息;异步任务结果需按对应查询接口核对。 |
success |
| httpStatusCode |
integer |
本次请求的处理状态,不等同后台任务最终结果。 |
200 |
| code |
string |
失败时结合 HTTP 状态及 message 处理。 |
SUCCESS |
| success |
boolean |
true 表示本次请求处理成功;异步写入仍需继续查询任务结果。 |
|
| data |
object |
结果结构见本接口返回字段;异步写接口的返回表示受理,不保证后台任务已完成。 |
|
| configuration |
object |
SAML 实际配置只在 GetIdentityProvider 按需回读;SCIM 查询和准备返回实际接收状态及 URL。 |
|
| status |
string |
Enabled 表示已开启 SCIM 接收,Disabled 表示关闭;不等同 AC 的 syncEnabled 期望值。 |
Enabled |
| baseUrl |
string |
配置给外部预配系统的 URL;有地址不代表已完成外部配置或开启 AC 同步。 |
https://example.com/scim/v2 |
| credential |
object |
credentialId、status、createTime、expireTime;不包含可重复获取的 Token。 |
|
| credentialId |
string |
删除时必填非空,使用凭据列表返回的 ID,不是 Token 明文。 |
credential-example |
| status |
string |
仅 Enabled 且尚未过期的凭据视为可用;此字段不是 SCIM 任务 operationStatus。 |
Enabled |
| createTime |
string |
AgentIdentity 返回的创建时间。 |
2026-10-26T00:00:00Z |
| expireTime |
string |
AgentIdentity 返回的到期时间;仅 Enabled 且尚未过期的凭据视为可用。 |
2027-10-26T00:00:00Z |
| token |
string |
新建凭据才返回明文,prepare 复用有效凭据时为 null;列表无法重取。响应丢失应先查询列表,不自动重签发;不写入日志或前端持久化缓存。 |
example-scim-token |
示例
正常返回示例
JSON格式
{
"requestId": "request-example",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": true,
"data": {
"configuration": {
"status": "Enabled",
"baseUrl": "https://example.com/scim/v2"
},
"credential": {
"credentialId": "credential-example",
"status": "Enabled",
"createTime": "2026-10-26T00:00:00Z",
"expireTime": "2027-10-26T00:00:00Z"
},
"token": "example-scim-token"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。