openstack/keystone
Code Issues Proposed changes

Document token header in federation auth response

Browse Source 
When reading the OS-FEDERATION API documentation, it is not clear how
to find the ID of the token when requesting either an unscoped or
scoped token. Token requests for the OS-FEDERATION API work the same
way as for the standard API, which is that the token ID is returned in
the X-Subject-Token header, so let's just mention that in the
OS-FEDERATION API documentation.

Change-Id: I6e9743d9001684f0d05ace119509f643c8b8e363
This commit is contained in:
Colleen Murphy 2016-11-28 12:44:39 +01:00 committed by Rodrigo Duarte Sousa
parent fcebc2fa8d
commit 22233747d2
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/v3-ext/federation/auth/auth.inc
View File

@ -40,6 +40,7 @@ Response
.. rest_parameters:: federation/auth/parameters.yaml .. rest_parameters:: federation/auth/parameters.yaml
- X-Subject-Token: X-Subject-Token
- token: unscoped_token - token: unscoped_token
Response Example Response Example
@ -81,6 +82,7 @@ Response
.. rest_parameters:: federation/auth/parameters.yaml .. rest_parameters:: federation/auth/parameters.yaml
- X-Subject-Token: X-Subject-Token
- token: scoped_token - token: scoped_token
Response Example Response Example

9
api-ref/source/v3-ext/federation/auth/parameters.yaml
View File

@ -1,5 +1,14 @@
# variables in header # variables in header
X-Subject-Token:
description: |
The authentication token. An authentication
response returns the token ID in this header rather than in the
response body.
in: header
required: true
type: string
# variables in path # variables in path
idp_id: idp_id: