更新协议

功能介绍

该接口用于更新协议信息。

URI

• URI格式

  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

• 参数说明

  参数	是否必选	类型	说明
  idp_id	是	String	身份提供商的ID。
  protocol _id	是	String	Protocol的ID。

请求

• Request Header参数说明

  参数	是否必选	类型	说明
  Content-Type	是	String	该字段内容填为“application/json;charset=utf8”。
  X-Auth-Token	是	String	已认证的拥有Security Administrator权限的token。

• Request Body参数说明

  参数	是否必选	类型	说明
  mapping_id	是	String	映射的ID。

• 请求样例

  curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X PATCH -d'{"protocol":{"mapping_id":"ACME"}}' https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml

响应

• Response Body参数说明

  参数	是否必选	类型	说明
  id	是	String	Protocol的ID。
  mapping_id	是	String	映射的ID。
  links	是	Object	Protocol的资源链接。

• 响应样例

  {
      "protocol": {
          "id": "saml",
          "links": {
              "identity_provider": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME",
              "self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml"
          },
          "mapping_id": "ACME"
      }
  }

状态码