GetIdentityProviderSCIM - 查询 SCIM 配置及独立操作状态
查询 SCIM 实际接收配置、AC 同步期望开关和最近一次独立 SCIM 任务状态。无需先配置 SAML。
接口说明
功能与前提\n 要求共享 CustomSSO 用户池已创建且不处于整体解绑或解绑失败;无需先配置 SAML,SAML 更新中或更新失败不阻塞查询。configuration.status/baseUrl 来自 AgentIdentity,syncEnabled 是 AC 期望同步开关,operationStatus 是最近一次独立 SCIM 开关及开启时首次全量导入任务。地址存在不代表外部预配完成,也不代表 AC 已启用同步。\noperationStatus:PENDING 等待、RUNNING 执行中、PAUSED 暂停、SUCCESS 成功、FAILED 失败、CANCELED 已取消;无历史任务时 null 或不返回。PENDING、RUNNING 时可轮询;终态停止轮询,PAUSED 可手动刷新。本接口不提供 taskId 或失败详情,不表示凭据签发、外部预配连接测试或持续增量同步健康。关闭后可能仍保留 URL、凭据和历史任务记录。\n\nstatus 是独立 SCIM 配置状态:UNCONFIGURED 未准备完成;WAITING_CONFIGURATION 接收端开启、HTTPS URL 有效且存在有效 Token,等待外部配置和启用确认;UPDATING 启用或停用正在执行;READY 同步启用且本次启用任务成功,接收端、URL 和凭证仍可用;DISABLED 已停用并保留配置;UPDATE_FAILED 操作失败、暂停、取消或启用后配置/凭据不可用。保留 configuration、syncEnabled、operationStatus 原始事实,不使用 SAML/OIDC 绑定状态判断 SCIM。READY 不证明 Matrix 执行完成、外部连接测试通过或持续增量健康。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/scim-provisioning\n 调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\ntext\nGET /workspaces/ws-example/scim-provisioning\n\n\n## 返回示例\njson\n{\n "data": {\n "status": "READY",\n "configuration": {\n "status": "Enabled",\n "baseUrl": "https://example.com/scim/v2"\n },\n "syncEnabled": true,\n "operationStatus": "SUCCESS"\n }\n}\n\n\n## 错误与处理\n 错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:共享用户池尚不可用、解绑中或解绑失败。无绑定为 404 IdentityProviderNotFound。上游读取失败需保留错误,不能映射为 Disabled、未配置或同步成功。\n\n## 调用关系与使用边界\nSCIM 配置顺序:准备共享池后调用 PrepareIdentityProviderSCIM,将其返回的 baseUrl 和新签发 Token 配置到外部 IdP 的预配系统;完成外部连接测试后调用 UpdateIdentityProviderSCIM 开启同步,再通过本接口查询 operationStatus。SUCCESS 仅表示最近一次 SCIM 任务完成,不代表持续增量同步健康或外部预配连接测试成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:GetIdentityProviderSCIM |
get |
*IdentityProvider
|
无 | 无 |
请求语法
GET /workspaces/{workspaceId}/scim-provisioning 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 |
结果结构见本接口返回字段;异步写接口的返回表示受理,不保证后台任务已完成。 |
|
| status |
string |
UNCONFIGURED:尚未准备完成;WAITING_CONFIGURATION:接收 Enabled、有效 HTTPS URL 和至少一个有效 Token 均已具备,等待外部配置并确认启用;UPDATING:启用或停用任务 PENDING/RUNNING;READY:同步已启用且本次启用任务成功,接收、URL 和 Token 仍可用;DISABLED:停用任务成功,保留配置、凭据和用户;UPDATE_FAILED:操作失败、暂停、取消,或期望启用时配置/凭据不可用。与 SAML/OIDC 状态独立,READY 不证明 Matrix 执行或持续增量链路已验收。 |
READY |
| configuration |
object |
SAML 实际配置只在 GetIdentityProvider 按需回读;SCIM 查询和准备返回实际接收状态及 URL。 |
|
| status |
string |
Enabled 表示已开启 SCIM 接收,Disabled 表示关闭;不等同 AC 的 syncEnabled 期望值。 |
Enabled |
| baseUrl |
string |
配置给外部预配系统的 URL;有地址不代表已完成外部配置或开启 AC 同步。 |
https://example.com/scim/v2 |
| syncEnabled |
boolean |
CustomSSO 初始化时不传 true;后续只能通过 UpdateIdentityProviderSCIM 更新,结果结合 operationStatus 判断。 |
|
| operationStatus |
string |
与 SAML 登录绑定状态独立。PENDING:等待执行;RUNNING:执行中;PAUSED:暂停;SUCCESS:成功;FAILED:失败;CANCELED:取消。尚无任务时为 null 或不返回。仅表示最近一次 SCIM 开关及开启时首次全量导入任务,不表示凭据签发、外部预配连接测试或持续增量同步健康。客户端在 PENDING、RUNNING 时轮询本接口。 |
SUCCESS |
示例
正常返回示例
JSON格式
{
"requestId": "request-example",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": true,
"data": {
"status": "READY",
"configuration": {
"status": "Enabled",
"baseUrl": "https://example.com/scim/v2"
},
"syncEnabled": true,
"operationStatus": "SUCCESS"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。