Colleen Murphy 22233747d2 Document token header in federation auth response
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
2016-11-28 09:06:25 -03:00

53 lines
979 B
YAML

# 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
idp_id:
description: |
Identity Provider's unique ID
in: path
required: true
type: object
protocol_id:
description: |
Federation Protocol's unique ID
in: path
required: true
type: object
# variables in query
# variables in body
auth:
description: |
Auth data containing user's identity and scope information
in: body
required: true
type: object
scoped_token:
description: |
Federation scoped token containing methods, roles, user, scope, catalog,
issuance and expiry information
in: body
required: true
type: object
unscoped_token:
description: |
Federation unscoped token containing methods and user information
in: body
required: true
type: object