#%RAML 0.8

type: x-auth-token

description: |

    *A custom X-Auth-Token header supporting authentication*

    All requests must include the X-Auth-Token header; this header
    must contain a valid token as obtained from the /tokens service.

describedBy:

  headers:
    X-Auth-Token:
      description: a token created by the token authentication service
      displayName: Authentication Token
      type: string
      pattern: ^[A-F0-9]{20}$

  responses:
    401:
      description: Authentication failure - bad or expired token.
    403:
      description: Authorization failure - resource access denied.
