openstack/keystone
Code Issues Proposed changes

Merge "Make federation documentation consistent"

Browse Source
This commit is contained in:
Jenkins
2017-08-04 00:03:22 +00:00
committed by Gerrit Code Review
parent fffc84db79 db8d02f2b3
commit a7648fd65f
3 changed files with 10 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-ref/source/v3-ext/federation/identity-provider/idp.inc
+4 -9
View File
@@ -1,14 +1,13 @@
.. -*- rst -*-
Register an Identity Provider
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 codes: 201
Error response codes: 409
Normal response code: 201
Request
-------
@@ -21,8 +20,8 @@ Request
- 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.
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
---------------
@@ -145,7 +144,6 @@ When an identity provider is disabled, any tokens generated by that identity
provider will be revoked.
Normal response codes: 200
Error response codes: 400, 409
Request
-------
@@ -192,7 +190,6 @@ Add a protocol and attribute mapping to an identity provider
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 201
Error response codes: 400
Request
-------
@@ -232,7 +229,6 @@ Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDER
Normal response codes: 200
Request
-------
@@ -294,7 +290,6 @@ Update the attribute mapping for an identity provider and protocol
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 200
Error response codes: 400
Request
-------
api-ref/source/v3-ext/federation/mapping/mapping.inc
+2 -2
View File
@@ -110,8 +110,8 @@ Response Example
:language: javascript
List all mappings
=================
List mappings
=============
.. rest_method:: GET /v3/OS-FEDERATION/mappings
api-ref/source/v3-ext/federation/service-provider/sp.inc
+4 -8
View File
@@ -1,6 +1,6 @@
.. -*- rst -*-
Register a Service Provider
Register a service provider
===========================
.. rest_method:: PUT /v3/OS-FEDERATION/service_providers/{id}
@@ -8,8 +8,6 @@ Register a Service Provider
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 201
Error response codes: 400 Bad Request when registering a service provider with
invalid URLs for either `auth_url` or `sp_url`.
Request
-------
@@ -48,8 +46,8 @@ Response Example
:language: javascript
Listing Service Providers
=========================
List service providers
======================
.. rest_method:: GET /v3/OS-FEDERATION/service_providers
@@ -125,7 +123,7 @@ Request
- id: id_path
Update Service Provider
Update service provider
=======================
.. rest_method:: PATCH /v3/OS-FEDERATION/service_providers/{id}
@@ -133,8 +131,6 @@ Update Service Provider
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 200
Error response codes: 400 Bad Request when updating a service provider with
invalid URLs for either `auth_url` or `sp_url`.
Request
-------