<NME> idp.inc
<BEF> .. -*- rst -*-

Register an identity provider
=============================

.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``

Normal response code: 201

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - domain_id: domain_id
    - domain_id: domain_id
    - description: description
    - enabled: enabled
    - id: id_path
    - remote_ids: remote_ids
As a domain may only be associated to a single identity provider, a 409 response code will be
returned if the specified ``domain_id`` already maps an existing identity provider.

Request Example
---------------

.. literalinclude:: federation/identity-provider/samples/register-request.json
   :language: javascript
   :language: javascript
Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - domain_id: domain_id
    - authorization_ttl: authorization_ttl
    - domain_id: domain_id
    - description: description
    - links: links
    - remote_ids: remote_ids

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/register-response.json
   :language: javascript
.. literalinclude:: federation/identity-provider/samples/register-response.json
   :language: javascript



.. rest_method::  GET /v3/OS-FEDERATION/identity_providers

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``

Normal response codes: 200

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - id: id_query

    - id: id_query
Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - identity_providers: identity_providers

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/list-response.json
   :language: javascript


Get Identity provider
=====================

.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``

Normal response codes: 200

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - id: id_path

Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - domain_id: domain_id

    - authorization_ttl: authorization_ttl
    - domain_id: domain_id
    - links: links
    - remote_ids: remote_ids

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/get-response.json
   :language: javascript

.. literalinclude:: federation/identity-provider/samples/get-response.json
   :language: javascript


.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``

When an identity provider is deleted, any tokens generated by that identity
provider will be revoked.

Normal response codes: 204

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - id: id_path

Update identity provider
========================

.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``

When an identity provider is disabled, any tokens generated by that identity
provider will be revoked.

Normal response codes: 200

Request
-------

Request
-------
recreate the Identity Provider. If ``domain_id`` is included in the request, a
400 response code will be returned.

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - id: id_path

Request Example
---------------

.. literalinclude:: federation/identity-provider/samples/update-request.json
   :language: javascript

Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - domain_id: domain_id
.. rest_parameters:: federation/identity-provider/parameters.yaml

    - authorization_ttl: authorization_ttl
    - links: links
    - remote_ids: remote_ids

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/update-response.json
   :language: javascript


Add a protocol and attribute mapping to an identity provider
============================================================

.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``

Normal response codes: 201

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - idp_id: id_path
    - protocol_id: protocol_id
    - protocol: protocol

Request Example
---------------

.. literalinclude:: federation/identity-provider/samples/add-protocol-request.json
   :language: javascript
~~~~~~~
Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - protocol: protocol

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/add-protocol-response.json
   :language: javascript


List all protocol and attribute mappings of an identity provider
================================================================

.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``

Normal response codes: 200

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - id: id_path

Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - protocols: protocols
    - links: protocols_links

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/list-protocol-response.json
   :language: javascript


Get a protocol and attribute mapping for an identity provider
=============================================================

.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``

Normal response codes: 200

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - idp_id: id_path

.. rest_parameters:: federation/identity-provider/parameters.yaml
Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - protocol: protocol

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/get-protocol-response.json
   :language: javascript


Update the attribute mapping for an identity provider and protocol
==================================================================

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

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``

Normal response codes: 200

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - idp_id: id_path
    - protocol_id: protocol_id
    - protocol: protocol

Request Example
---------------

.. literalinclude:: federation/identity-provider/samples/update-protocol-request.json
   :language: javascript
~~~~~~~
Response
--------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - protocol: protocol

Response Example
----------------

.. literalinclude:: federation/identity-provider/samples/update-protocol-response.json
   :language: javascript


Delete a protocol and attribute mapping from an identity provider
=================================================================

.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``

Normal response codes: 204

Request
-------

.. rest_parameters:: federation/identity-provider/parameters.yaml

    - idp_id: id_path
    - protocol_id: protocol_id

.. rest_status_code:: success ../v3/status.yaml

   - 204

<MSG> Merge "Reorganize api-ref: v3-ext federation identity-provider"
<DFF> @@ -5,13 +5,15 @@ Register an identity provider
 
 .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
+Register an identity provider to be used to authenticate federated users.
 
-Normal response code: 201
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - domain_id: domain_id
@@ -23,8 +25,8 @@ Request
 As a domain may only be associated to a single identity provider, a 409 response code will be
 returned if the specified ``domain_id`` already maps an existing identity provider.
 
-Request Example
----------------
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/register-request.json
    :language: javascript
@@ -32,6 +34,9 @@ Request Example
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - domain_id: domain_id
@@ -41,8 +46,15 @@ Response
     - links: links
     - remote_ids: remote_ids
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 201
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/register-response.json
    :language: javascript
@@ -53,13 +65,16 @@ List identity providers
 
 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``
+List registered identity providers.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - id: id_query
@@ -68,29 +83,42 @@ Request
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - identity_providers: identity_providers
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/list-response.json
    :language: javascript
 
 
-Get Identity provider
+Get identity provider
 =====================
 
 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
+Get registered identity providers.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - id: id_path
@@ -98,6 +126,9 @@ Request
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - domain_id: domain_id
@@ -107,8 +138,15 @@ Response
     - links: links
     - remote_ids: remote_ids
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/get-response.json
    :language: javascript
@@ -119,31 +157,40 @@ Delete identity provider
 
 .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
-
 When an identity provider is deleted, any tokens generated by that identity
 provider will be revoked.
 
-Normal response codes: 204
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - id: id_path
 
+Response
+--------
+
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 204
+
 Update identity provider
 ========================
 
 .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
-
 When an identity provider is disabled, any tokens generated by that identity
 provider will be revoked.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
 
 Request
 -------
@@ -153,12 +200,15 @@ the request body. To update the ``domain_id``, you will need to delete and
 recreate the Identity Provider. If ``domain_id`` is included in the request, a
 400 response code will be returned.
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - id: id_path
 
-Request Example
----------------
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/update-request.json
    :language: javascript
@@ -166,6 +216,9 @@ Request Example
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - domain_id: domain_id
@@ -175,33 +228,43 @@ Response
     - links: links
     - remote_ids: remote_ids
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/update-response.json
    :language: javascript
 
 
-Add a protocol and attribute mapping to an identity provider
-============================================================
+Add protocol to identity provider
+=================================
 
 .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
+Add a protocol and attribute mapping to an identity provider.
 
-Normal response codes: 201
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - idp_id: id_path
     - protocol_id: protocol_id
     - protocol: protocol
 
-Request Example
----------------
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/add-protocol-request.json
    :language: javascript
@@ -209,29 +272,42 @@ Request Example
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - protocol: protocol
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 201
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/add-protocol-response.json
    :language: javascript
 
 
-List all protocol and attribute mappings of an identity provider
-================================================================
+List protocols of identity provider
+===================================
 
 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``
+List all protocol and attribute mappings of an identity provider.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - id: id_path
@@ -239,30 +315,43 @@ Request
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - protocols: protocols
     - links: protocols_links
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/list-protocol-response.json
    :language: javascript
 
 
-Get a protocol and attribute mapping for an identity provider
-=============================================================
+Get protocol for identity provider
+==================================
 
 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
+Get a protocol and attribute mapping for an identity provider.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - idp_id: id_path
@@ -271,37 +360,50 @@ Request
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - protocol: protocol
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/get-protocol-response.json
    :language: javascript
 
 
-Update the attribute mapping for an identity provider and protocol
-==================================================================
+Update attribute mapping for identity provider
+==============================================
 
 .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
+Update the attribute mapping for an identity provider and protocol.
 
-Normal response codes: 200
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - idp_id: id_path
     - protocol_id: protocol_id
     - protocol: protocol
 
-Request Example
----------------
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/update-protocol-request.json
    :language: javascript
@@ -309,30 +411,53 @@ Request Example
 Response
 --------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - protocol: protocol
 
-Response Example
-----------------
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 200
+
+Example
+~~~~~~~
 
 .. literalinclude:: federation/identity-provider/samples/update-protocol-response.json
    :language: javascript
 
 
-Delete a protocol and attribute mapping from an identity provider
-=================================================================
+Delete a protocol from identity provider
+========================================
 
 .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
 
-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
+Delete a protocol and attribute mapping from an identity provider.
 
-Normal response codes: 204
+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
 
 Request
 -------
 
+Parameters
+~~~~~~~~~~
+
 .. rest_parameters:: federation/identity-provider/parameters.yaml
 
     - idp_id: id_path
     - protocol_id: protocol_id
+
+Response
+--------
+
+Status Codes
+~~~~~~~~~~~~
+
+.. rest_status_code:: success ../v3/status.yaml
+
+   - 204
\ No newline at end of file

{'commit': 'diff --git a/api-ref/source/v3-ext/federation/identity-provider/idp.inc b/api-ref/source/v3-ext/federation/identity-provider/idp.inc\nindex d4399a4ad..9896082aa 100644\n--- a/api-ref/source/v3-ext/federation/identity-provider/idp.inc\n+++ b/api-ref/source/v3-ext/federation/identity-provider/idp.inc\n@@ -5,13 +5,15 @@ Register an identity provider\n \n .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n+Register an identity provider to be used to authenticate federated users.\n \n-Normal response code: 201\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -23,8 +25,8 @@ Request\n As a domain may only be associated to a single identity provider, a 409 response code will be\n returned if the specified ``domain_id`` already maps an existing identity provider.\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/register-request.json\n    :language: javascript\n@@ -32,6 +34,9 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -41,8 +46,15 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 201\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/register-response.json\n    :language: javascript\n@@ -53,13 +65,16 @@ List identity providers\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``\n+List registered identity providers.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_query\n@@ -68,29 +83,42 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - identity_providers: identity_providers\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/list-response.json\n    :language: javascript\n \n \n-Get Identity provider\n+Get identity provider\n =====================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n+Get registered identity providers.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n@@ -98,6 +126,9 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -107,8 +138,15 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/get-response.json\n    :language: javascript\n@@ -119,31 +157,40 @@ Delete identity provider\n \n .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n-\n When an identity provider is deleted, any tokens generated by that identity\n provider will be revoked.\n \n-Normal response codes: 204\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n \n+Response\n+--------\n+\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 204\n+\n Update identity provider\n ========================\n \n .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n-\n When an identity provider is disabled, any tokens generated by that identity\n provider will be revoked.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n@@ -153,12 +200,15 @@ the request body. To update the ``domain_id``, you will need to delete and\n recreate the Identity Provider. If ``domain_id`` is included in the request, a\n 400 response code will be returned.\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-request.json\n    :language: javascript\n@@ -166,6 +216,9 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -175,33 +228,43 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-response.json\n    :language: javascript\n \n \n-Add a protocol and attribute mapping to an identity provider\n-============================================================\n+Add protocol to identity provider\n+=================================\n \n .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Add a protocol and attribute mapping to an identity provider.\n \n-Normal response codes: 201\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n     - protocol: protocol\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/add-protocol-request.json\n    :language: javascript\n@@ -209,29 +272,42 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 201\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/add-protocol-response.json\n    :language: javascript\n \n \n-List all protocol and attribute mappings of an identity provider\n-================================================================\n+List protocols of identity provider\n+===================================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``\n+List all protocol and attribute mappings of an identity provider.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n@@ -239,30 +315,43 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocols: protocols\n     - links: protocols_links\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/list-protocol-response.json\n    :language: javascript\n \n \n-Get a protocol and attribute mapping for an identity provider\n-=============================================================\n+Get protocol for identity provider\n+==================================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Get a protocol and attribute mapping for an identity provider.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n@@ -271,37 +360,50 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/get-protocol-response.json\n    :language: javascript\n \n \n-Update the attribute mapping for an identity provider and protocol\n-==================================================================\n+Update attribute mapping for identity provider\n+==============================================\n \n .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Update the attribute mapping for an identity provider and protocol.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n     - protocol: protocol\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-protocol-request.json\n    :language: javascript\n@@ -309,30 +411,53 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-protocol-response.json\n    :language: javascript\n \n \n-Delete a protocol and attribute mapping from an identity provider\n-=================================================================\n+Delete a protocol from identity provider\n+========================================\n \n .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Delete a protocol and attribute mapping from an identity provider.\n \n-Normal response codes: 204\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n+\n+Response\n+--------\n+\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 204\n\\ No newline at end of file\n', 'commit_subject': 'Merge "Reorganize api-ref: v3-ext federation identity-provider"', 'repo_name': 'openstack/keystone', 'committer': {'name': 'Gerrit Code Review', 'email': '61e62b213a1a56f7695845df4fc372a10cb0a73e@openstack.org', 'time_sec': '1518109768', 'tz_offset': '0', 'date': {'seconds': '1518109768'}}, 'commit_tree': '6643bd1d36d4b08cf12dffe2d1585f05f825ae16', 'commit_message': 'Merge "Reorganize api-ref: v3-ext federation identity-provider"', 'language_name': 'HTML', 'license': 'apache-2.0', 'hunks': '@@ -5,13 +5,15 @@ Register an identity provider\n \n .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n+Register an identity provider to be used to authenticate federated users.\n \n-Normal response code: 201\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -23,8 +25,8 @@ Request\n As a domain may only be associated to a single identity provider, a 409 response code will be\n returned if the specified ``domain_id`` already maps an existing identity provider.\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/register-request.json\n    :language: javascript\n@@ -32,6 +34,9 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -41,8 +46,15 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 201\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/register-response.json\n    :language: javascript\n@@ -53,13 +65,16 @@ List identity providers\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``\n+List registered identity providers.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_query\n@@ -68,29 +83,42 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - identity_providers: identity_providers\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/list-response.json\n    :language: javascript\n \n \n-Get Identity provider\n+Get identity provider\n =====================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n+Get registered identity providers.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n@@ -98,6 +126,9 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -107,8 +138,15 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/get-response.json\n    :language: javascript\n@@ -119,31 +157,40 @@ Delete identity provider\n \n .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n-\n When an identity provider is deleted, any tokens generated by that identity\n provider will be revoked.\n \n-Normal response codes: 204\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n \n+Response\n+--------\n+\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 204\n+\n Update identity provider\n ========================\n \n .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n-\n When an identity provider is disabled, any tokens generated by that identity\n provider will be revoked.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n \n Request\n -------\n@@ -153,12 +200,15 @@ the request body. To update the ``domain_id``, you will need to delete and\n recreate the Identity Provider. If ``domain_id`` is included in the request, a\n 400 response code will be returned.\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-request.json\n    :language: javascript\n@@ -166,6 +216,9 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - domain_id: domain_id\n@@ -175,33 +228,43 @@ Response\n     - links: links\n     - remote_ids: remote_ids\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-response.json\n    :language: javascript\n \n \n-Add a protocol and attribute mapping to an identity provider\n-============================================================\n+Add protocol to identity provider\n+=================================\n \n .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Add a protocol and attribute mapping to an identity provider.\n \n-Normal response codes: 201\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n     - protocol: protocol\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/add-protocol-request.json\n    :language: javascript\n@@ -209,29 +272,42 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 201\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/add-protocol-response.json\n    :language: javascript\n \n \n-List all protocol and attribute mappings of an identity provider\n-================================================================\n+List protocols of identity provider\n+===================================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``\n+List all protocol and attribute mappings of an identity provider.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - id: id_path\n@@ -239,30 +315,43 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocols: protocols\n     - links: protocols_links\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/list-protocol-response.json\n    :language: javascript\n \n \n-Get a protocol and attribute mapping for an identity provider\n-=============================================================\n+Get protocol for identity provider\n+==================================\n \n .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Get a protocol and attribute mapping for an identity provider.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n@@ -271,37 +360,50 @@ Request\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/get-protocol-response.json\n    :language: javascript\n \n \n-Update the attribute mapping for an identity provider and protocol\n-==================================================================\n+Update attribute mapping for identity provider\n+==============================================\n \n .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Update the attribute mapping for an identity provider and protocol.\n \n-Normal response codes: 200\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n     - protocol: protocol\n \n-Request Example\n----------------\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-protocol-request.json\n    :language: javascript\n@@ -309,30 +411,53 @@ Request Example\n Response\n --------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - protocol: protocol\n \n-Response Example\n-----------------\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 200\n+\n+Example\n+~~~~~~~\n \n .. literalinclude:: federation/identity-provider/samples/update-protocol-response.json\n    :language: javascript\n \n \n-Delete a protocol and attribute mapping from an identity provider\n-=================================================================\n+Delete a protocol from identity provider\n+========================================\n \n .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n \n-Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n+Delete a protocol and attribute mapping from an identity provider.\n \n-Normal response codes: 204\n+Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n \n Request\n -------\n \n+Parameters\n+~~~~~~~~~~\n+\n .. rest_parameters:: federation/identity-provider/parameters.yaml\n \n     - idp_id: id_path\n     - protocol_id: protocol_id\n+\n+Response\n+--------\n+\n+Status Codes\n+~~~~~~~~~~~~\n+\n+.. rest_status_code:: success ../v3/status.yaml\n+\n+   - 204\n\\ No newline at end of file\n', 'addition_count': 182, 'deletion_count': 57, 'src_file': 'a/api-ref/source/v3-ext/federation/identity-provider/idp.inc', 'tgt_file': 'b/api-ref/source/v3-ext/federation/identity-provider/idp.inc', 'file_extension': '.inc', 'before_file': '.. -*- rst -*-\n\nRegister an identity provider\n=============================\n\n.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n\nNormal response code: 201\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - domain_id: domain_id\n    - domain_id: domain_id\n    - description: description\n    - enabled: enabled\n    - id: id_path\n    - remote_ids: remote_ids\nAs a domain may only be associated to a single identity provider, a 409 response code will be\nreturned if the specified ``domain_id`` already maps an existing identity provider.\n\nRequest Example\n---------------\n\n.. literalinclude:: federation/identity-provider/samples/register-request.json\n   :language: javascript\n   :language: javascript\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - domain_id: domain_id\n    - authorization_ttl: authorization_ttl\n    - domain_id: domain_id\n    - description: description\n    - links: links\n    - remote_ids: remote_ids\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/register-response.json\n   :language: javascript\n.. literalinclude:: federation/identity-provider/samples/register-response.json\n   :language: javascript\n\n\n\n.. rest_method::  GET /v3/OS-FEDERATION/identity_providers\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``\n\nNormal response codes: 200\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - id: id_query\n\n    - id: id_query\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - identity_providers: identity_providers\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/list-response.json\n   :language: javascript\n\n\nGet Identity provider\n=====================\n\n.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n\nNormal response codes: 200\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - id: id_path\n\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - domain_id: domain_id\n\n    - authorization_ttl: authorization_ttl\n    - domain_id: domain_id\n    - links: links\n    - remote_ids: remote_ids\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/get-response.json\n   :language: javascript\n\n.. literalinclude:: federation/identity-provider/samples/get-response.json\n   :language: javascript\n\n\n.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n\nWhen an identity provider is deleted, any tokens generated by that identity\nprovider will be revoked.\n\nNormal response codes: 204\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - id: id_path\n\nUpdate identity provider\n========================\n\n.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``\n\nWhen an identity provider is disabled, any tokens generated by that identity\nprovider will be revoked.\n\nNormal response codes: 200\n\nRequest\n-------\n\nRequest\n-------\nrecreate the Identity Provider. If ``domain_id`` is included in the request, a\n400 response code will be returned.\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - id: id_path\n\nRequest Example\n---------------\n\n.. literalinclude:: federation/identity-provider/samples/update-request.json\n   :language: javascript\n\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - domain_id: domain_id\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - authorization_ttl: authorization_ttl\n    - links: links\n    - remote_ids: remote_ids\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/update-response.json\n   :language: javascript\n\n\nAdd a protocol and attribute mapping to an identity provider\n============================================================\n\n.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n\nNormal response codes: 201\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - idp_id: id_path\n    - protocol_id: protocol_id\n    - protocol: protocol\n\nRequest Example\n---------------\n\n.. literalinclude:: federation/identity-provider/samples/add-protocol-request.json\n   :language: javascript\n~~~~~~~\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - protocol: protocol\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/add-protocol-response.json\n   :language: javascript\n\n\nList all protocol and attribute mappings of an identity provider\n================================================================\n\n.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``\n\nNormal response codes: 200\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - id: id_path\n\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - protocols: protocols\n    - links: protocols_links\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/list-protocol-response.json\n   :language: javascript\n\n\nGet a protocol and attribute mapping for an identity provider\n=============================================================\n\n.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n\nNormal response codes: 200\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - idp_id: id_path\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - protocol: protocol\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/get-protocol-response.json\n   :language: javascript\n\n\nUpdate the attribute mapping for an identity provider and protocol\n==================================================================\n\n.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n\nNormal response codes: 200\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - idp_id: id_path\n    - protocol_id: protocol_id\n    - protocol: protocol\n\nRequest Example\n---------------\n\n.. literalinclude:: federation/identity-provider/samples/update-protocol-request.json\n   :language: javascript\n~~~~~~~\nResponse\n--------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - protocol: protocol\n\nResponse Example\n----------------\n\n.. literalinclude:: federation/identity-provider/samples/update-protocol-response.json\n   :language: javascript\n\n\nDelete a protocol and attribute mapping from an identity provider\n=================================================================\n\n.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}\n\nRelationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``\n\nNormal response codes: 204\n\nRequest\n-------\n\n.. rest_parameters:: federation/identity-provider/parameters.yaml\n\n    - idp_id: id_path\n    - protocol_id: protocol_id\n\n.. rest_status_code:: success ../v3/status.yaml\n\n   - 204\n', 'message': 'Merge "Reorganize api-ref: v3-ext federation identity-provider"', 'author_name': 'Gerrit Code Review', 'lang': 'inc'}