diff --git a/api-ref/source/v3-ext/federation/identity-provider/idp.inc b/api-ref/source/v3-ext/federation/identity-provider/idp.inc index d4399a4ad9..9896082aad 100644 --- a/api-ref/source/v3-ext/federation/identity-provider/idp.inc +++ b/api-ref/source/v3-ext/federation/identity-provider/idp.inc @@ -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