文档API 参考

Rust · 0.1.0

Update Identity Provider

PATCH /api/v1/identity-providers/{identity-provider}

IdentityProviderService · IdentityProviderService_UpdateIdentityProvider

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义;本站不会向真实服务执行示例。

访问权限

需要实例管理员;普通已认证账号不能执行此操作。

支持的变更与秘密处理

要求非空掩码。支持 title、identifier_filter 和 config,其他路径在此实现中被忽略。替换 OAuth 配置时,空 clientSecret 会保留原有秘密。返回对象省略 clientSecret,因此读取为空不代表没有配置秘密。

请求

UpdateIdentityProvider updates an identity provider.

PATCH/api/v1/identity-providers/{identity-provider}

参数

名称 / 位置类型 / 是否必需描述
identity-provider
path
string
必需
The identity-provider id.
updateMask
query
string (field-mask)
必需(接口描述)
Required. The update mask applies to the resource. Only the top level fields of IdentityProvider are supported.

请求体

必需

application/json · IdentityProvider

响应

200 · OK

application/json · IdentityProvider

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义
{
  "tags": [
    "IdentityProviderService"
  ],
  "description": "UpdateIdentityProvider updates an identity provider.",
  "operationId": "IdentityProviderService_UpdateIdentityProvider",
  "parameters": [
    {
      "name": "identity-provider",
      "in": "path",
      "description": "The identity-provider id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "Required. The update mask applies to the resource. Only the top level fields of\n IdentityProvider are supported.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/IdentityProvider"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IdentityProvider"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}