DeleteIdentityProviderSCIMCredential - 删除 SCIM 凭据
撤销指定 SCIM 凭据。不会自动创建新 Token、修改 AC 同步开关或关闭 SAML 登录。
接口说明
功能与前提\n 撤销指定凭据,credentialId 必填且非空,从凭据列表取得。要求共享池可用,但不要求 SAML 已配置或 SCIM 接收为 Enabled。删除后使用该 Token 的外部预配请求会失效;只影响选定凭据,不自动关闭接收、不自动关闭 AC syncEnabled,也不影响另一枚凭据或 SAML。\n 即使删除最后一枚凭据,也不自动回写同步开关或重发新 Token;用户应按需要先停用外部预配或更换其使用的 Token。成功返回公共响应,无业务 data 内容;刷新列表确认。对未知或已删除 ID 的结果由上游决定,不承诺统一 404 或无条件幂等成功。\n\n## 请求与示例\nDELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId}\n 调用约定:按目标 Workspace 的地域调用,使用有相应 Workspace 身份源资源权限的 AK/STS 身份。下文示例中的 ws-example、URL、证书和 Token 均为占位值,需替换为真实值。请求体示例表示公开 API 的 body 参数内容,不是后端直连接口额外的 body 包装。返回示例只展示业务部分,外层还包括 requestId、success、code、message、httpStatusCode;排障请保留 requestId,不记录密钥。业务任务异步不意味着 HTTP 请求长连接等待完成。\ntext\nDELETE /workspaces/ws-example/scim-provisioning/credentials/credential-example\n\n\n## 返回示例\njson\n{\n "success": true,\n "httpStatusCode": 200\n}\n\n\n## 错误与处理\n 错误处理:400 InvalidParameter 表示参数或当前配置前提不满足;404 IdentityProviderNotFound 表示没有匹配类型的绑定。同步调用上游失败可能返回 503 IdentityProviderProvisioningUnavailable;保留请求 ID 排查,不把读取失败解释为未配置。实际鉴权和 Workspace 不存在错误沿用公共错误处理。\n400 InvalidParameter:credentialId 为空或共享池不可用。404 IdentityProviderNotFound 指绑定不存在,不代表所有未知凭据 ID 都返回该码。其他删除错误按上游结果处理,失败时刷新列表核对,不自动创建替代 Token。\n\n## 调用关系与使用边界\n 使用 ListIdentityProviderSCIMCredentials 取得 credentialId 后删除指定凭据。若外部预配系统仍使用该 Token,后续预配可能鉴权失败,因此应先确认实际使用情况。删除后不会自动创建新凭据、关闭 AC 同步开关或关闭 SAML 登录。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:DeleteIdentityProviderSCIMCredential |
delete |
*IdentityProvider
|
无 | 无 |
请求语法
DELETE /workspaces/{workspaceId}/scim-provisioning/credentials/{credentialId} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
必填,目标 Workspace 的标识;请求地域需与目标 Workspace 一致。 |
ws-example |
| credentialId |
string |
是 |
删除时必填非空,使用凭据列表返回的 ID,不是 Token 明文。 |
credential-example |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| requestId |
string |
用于关联本次调用与排障,失败时请保留。 |
request-example |
| message |
string |
请求受理或错误消息;异步任务结果需按对应查询接口核对。 |
success |
| httpStatusCode |
integer |
本次请求的处理状态,不等同后台任务最终结果。 |
200 |
| code |
string |
失败时结合 HTTP 状态及 message 处理。 |
SUCCESS |
| success |
boolean |
true 表示本次请求处理成功;异步写入仍需继续查询任务结果。 |
示例
正常返回示例
JSON格式
{
"requestId": "request-example",
"message": "success",
"httpStatusCode": 200,
"code": "SUCCESS",
"success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。