Updating a Protocol

Function

This API is used to update the information about a protocol.

URI

• URI format

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

• URI parameters

  Parameter	Mandatory	Type	Description
  idp_id	Yes	String	ID of an identity provider.
  protocol _id	Yes	String	ID of a protocol.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token with the Security Administrator permission.

• Parameters in the request body

  Parameter	Mandatory	Type	Description
  mapping_id	Yes	String	Mapping ID.

• Example request

  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 Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  id	Yes	String	ID of a protocol.
  mapping_id	Yes	String	Mapping ID.
  links	Yes	Object	Protocol resource link.

• Example response

  {
      "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"
      }
  }

Status Codes