summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-02-02 11:29:45 -0600
committerGerrit Code Review <review@openstack.org>2014-03-19 23:27:58 +0000
commitb24351f91256c7b0bafbce2e17857927a70da32f (patch)
treed7c7d7a760ab715d29f4b6c55f37d4f427788d21 /doc
parentb63bd9c3d8c1f47a9354242eaee196713edde01f (diff)
downloadpython-keystoneclient-b24351f91256c7b0bafbce2e17857927a70da32f.tar.gz
Reference docstring for auth_token fields
The documented variables that the auth_token middleware sets for the request was out of date with the code. Rather than maintain the documentation for the fields in 2 places we'll now link to the auth_token module docs. Change-Id: Id4ca1843f749c1ed0b515c8860764add3ec4a3da
Diffstat (limited to 'doc')
-rw-r--r--doc/source/middlewarearchitecture.rst37
1 files changed, 4 insertions, 33 deletions
diff --git a/doc/source/middlewarearchitecture.rst b/doc/source/middlewarearchitecture.rst
index 245c79c..2b28c2a 100644
--- a/doc/source/middlewarearchitecture.rst
+++ b/doc/source/middlewarearchitecture.rst
@@ -315,41 +315,12 @@ Extended the request with additional User Information
-----------------------------------------------------
:py:class:`keystoneclient.middleware.auth_token.AuthProtocol` extends the
-request with additional information if the user has been authenticated.
+request with additional information if the user has been authenticated. See the
+"What we add to the request for use by the OpenStack service" section in
+:py:mod:`keystoneclient.middleware.auth_token` for the list of fields set by
+the auth_token middleware.
-X-Identity-Status
- Provides information on whether the request was authenticated or not.
-
-X-Tenant-Id
- The unique, immutable tenant Id
-
-X-Tenant-Name
- The unique, but mutable (it can change) tenant name.
-
-X-User-Id
- The user id of the user used to log in
-
-X-User-Name
- The username used to log in
-
-X-Roles
- The roles associated with that user
-
-Deprecated additions
---------------------
-
-X-Tenant
- Provides the tenant name. This is to support any legacy implementations
- before Keystone switched to an ID/Name schema for tenants.
-
-X-User
- The username used to log in. This is to support any legacy implementations
- before Keystone switched to an ID/Name schema for tenants.
-
-X-Role
- The roles associated with that user
-
References
==========