更新SAML身份提供商

功能介绍

该接口用于更新基于SAML协议的身份提供商信息。

URI

• URI格式

  PATCH /v3/OS-FEDERATION/identity_providers/{id}

• 参数说明

  参数	是否必选	类型	说明
  id	是	String	身份提供商的ID。

请求

• Request Header参数说明

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

• Request Body参数说明

  表1 请求Body参数

  参数	是否必选	参数类型	描述
  identity_provider	是	Object	身份提供商信息。

  表2 identity_provider

  参数	是否必选	参数类型	描述
  description	否	String	身份提供商描述信息。
  enabled	否	Boolean	身份提供商是否启用，true为启用，false为停用，默认为false。

• 请求样例

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

响应

• Response Body参数说明

  表3 响应Body参数

  参数	参数类型	描述
  identity_provider	Object	身份提供商信息。

  表4 identity_provider

  参数	参数类型	描述
  id	String	身份提供商ID。
  description	String	身份提供商描述信息。
  enabled	Boolean	身份提供商是否启用，true为启用，false为停用，默认为false。
  remote_ids	Array of strings	身份提供商的联邦用户ID列表。
  links	Object	身份提供商的资源链接信息。

  表5 identity_provider.links

  参数	参数类型	描述
  self	String	身份提供商的资源链接地址。
  protocols	String	协议的资源链接地址。

• 响应样例

  {
      "identity_provider": {
          "description": "Stores ACME identities",
          "enabled": false,
          "id": "ACME",
        
          "remote_ids": [],
          "links": {
              "protocols": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols",
              "self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME"
          }
      }
  }

状态码