openstack/keystone
Code Issues Proposed changes

Update federation docs to point to specs.o.org

Browse Source 
Currently, some parts of the federation docs points to links on
github.com. We should use the new specs.o.org/keystone/api links
instead.

Change-Id: I155e7491a9033c794ef7582bca18286b1b4a80aa
This commit is contained in:
Steve Martinelli 2014-11-14 11:25:14 -05:00
parent 5d376ba9ad
commit 8771aed5ae
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/configure_federation.rst
View File

@ -90,9 +90,9 @@ correspond to the Identity Provider's groups; additionally, these groups should
be assigned roles on one or more projects or domains.
You may be interested in more information on `group management
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3.md#create-group-post-groups>`_
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#create-group>`_
and `role assignments
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3.md#grant-role-to-group-on-project-put-projectsproject_idgroupsgroup_idrolesrole_id>`_,
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#grant-role-to-group-on-project>`_,
both of which are exposed to the CLI via `python-openstackclient
<https://pypi.python.org/pypi/python-openstackclient/>`_.
@ -106,7 +106,7 @@ To utilize federation the following must be created in the Identity Service:
* Protocol
More information on ``OS-FEDERATION`` can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html>`__.
~~~~~~~~~~~~~~~~~
Identity Provider
@ -116,7 +116,7 @@ Create an Identity Provider object in Keystone, which represents the Identity
Provider we will use to authenticate end users.
More information on identity providers can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#register-an-identity-provider-put-os-federationidentity_providersidp_id>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#register-an-identity-provider>`__.
~~~~~~~
Mapping
@ -130,7 +130,7 @@ An Identity Provider has exactly one mapping specified per protocol.
Mapping objects can be used multiple times by different combinations of Identity Provider and Protocol.
More information on mapping can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#create-a-mapping-put-os-federationmappingsmapping_id>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#create-a-mapping>`__.
~~~~~~~~
Protocol
@ -140,7 +140,7 @@ A protocol contains information that dictates which Mapping rules to use for an
request made by an IdP. An IdP may have multiple supported protocols.
Add `Protocol object
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#add-a-supported-protocol-and-attribute-mapping-combination-to-an-identity-provider-put-os-federationidentity_providersidp_idprotocolsprotocol_id>`__ and specify the mapping id
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#add-a-protocol-and-attribute-mapping-to-an-identity-provider>`__ and specify the mapping id
you want to use with the combination of the IdP and Protocol.
Performing federated authentication
@ -170,7 +170,7 @@ In the returned unscoped token, a list of Identity Service groups the user
belongs to will be included.
More information on getting an unscoped token can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#authenticating>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#authenticating>`__.
~~~~~~~~~~~~
Example cURL
@ -195,7 +195,7 @@ projects and domains that are accessible.
* List domains a federated user can access: ``GET /OS-FEDERATION/domains``
More information on listing resources can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#listing-projects-and-domains>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#listing-projects-and-domains>`__.
~~~~~~~~~~~~
Example cURL
@ -219,7 +219,7 @@ project or domain may be specified by either ``id`` or ``name``. An ``id`` is
sufficient to uniquely identify a project or domain.
More information on getting a scoped token can be found `here
<https://github.com/openstack/identity-api/blob/master/v3/src/markdown/identity-api-v3-os-federation-ext.md#request-a-scoped-os-federation-token-post-authtokens>`__.
<http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3-os-federation-ext.html#request-a-scoped-os-federation-token>`__.
~~~~~~~~~~~~
Example cURL