GetIdentityProviderServiceProvider - 查询 SAML 服务提供商信息
查询 CustomSSO 的 SAML SP 信息,包括 Entity ID、ACS URL 和 SP Metadata XML,供用户配置外部 IdP。
接口说明
功能与前提\n 要求已有可用 CustomSSO 共享用户池,identityProviderType=CustomSSO,protocol 必填且仅支持精确值 SAML;不要求先上传 IdP Metadata。返回我方 SP 的 entityId、acsUrl、metadataXml,供用户配置外部 IdP。它们不是外部 IdP 的登录 URL 或 IdP Entity ID,不能将 SP XML 作为 IdP XML 提交 UpdateIdentityProvider。\n 本接口只读取,不启用登录、不开启 SCIM、不创建凭据、不执行登录连接测试。共享池初始化中、解绑中或解绑失败时不可读取。\n\n## 请求与示例\nGET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider\n 调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\ntext\nGET /workspaces/ws-example/identity-providers/CustomSSO/service-provider?protocol=SAML\n\n\n## 返回示例\njson\n{\n "data": {\n "protocol": "SAML",\n "entityId": "<我方 SP Entity ID>",\n "acsUrl": "https://example.com/saml/acs",\n "metadataXml": "<我方 SP Metadata XML>"\n }\n}\n\n\n## 错误与处理\n 错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:identityProviderType 或 protocol 不支持。404 IdentityProviderNotFound:尚无 CustomSSO 绑定。409 IdentityProviderOperationConflict:用户池未准备好、解绑中或解绑失败。\n\n## 调用关系与使用边界\nSAML 配置顺序:CreateIdentityProvider 初始化 CustomSSO 共享池,等待 GetIdentityProvider 返回 READY;调用本接口取得 SP 信息并配置到外部 IdP;再将外部 IdP Metadata XML 或完整手填配置提交 UpdateIdentityProvider。保存后按需单独启用 loginEnabled。SP 信息查询不会完成外部 IdP 配置或验证登录。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:GetIdentityProviderServiceProvider |
get |
*IdentityProvider
|
无 | 无 |
请求语法
GET /workspaces/{workspaceId}/identity-providers/{identityProviderType}/service-provider HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
必填,目标 Workspace 的标识;请求地域需与目标 Workspace 一致。 |
ws-example |
| identityProviderType |
string |
是 |
本接口仅支持 CustomSSO。 |
CustomSSO |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| protocol |
string |
是 |
查询参数必填,仅支持精确值 SAML;响应返回 SAML。 |
SAML |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| requestId |
string |
用于关联本次调用与排障,失败时请保留。 |
request-example |
| message |
string |
请求受理或错误消息;异步任务结果需按对应查询接口核对。 |
success |
| httpStatusCode |
integer |
本次请求的处理状态,不等同后台任务最终结果。 |
200 |
| code |
string |
失败时结合 HTTP 状态及 message 处理。 |
SUCCESS |
| success |
boolean |
true 表示本次请求处理成功;异步写入仍需继续查询任务结果。 |
|
| data |
object |
结果结构见本接口返回字段;异步写接口的返回表示受理,不保证后台任务已完成。 |
|
| protocol |
string |
查询参数必填,仅支持精确值 SAML;响应返回 SAML。 |
SAML |
| entityId |
string |
我方 SP 的实体标识,配置到外部 IdP;不是外部 IdP Entity ID。 |
https://sp.example.com/entity |
| acsUrl |
string |
我方 SAML 断言消费地址,配置到外部 IdP。 |
https://sp.example.com/saml/acs |
| metadataXml |
string |
我方 SP Metadata XML,供外部 IdP 导入;不能作为 IdP XML 提交 SAML 配置。 |
|
示例
正常返回示例
JSON格式
{
"requestId": "request-example",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": true,
"data": {
"protocol": "SAML",
"entityId": "https://sp.example.com/entity",
"acsUrl": "https://sp.example.com/saml/acs",
"metadataXml": ""
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。