.. _apikey-authenticator:

**********************
API Key Authentication
**********************

The API Key authentication method requires an additional header to be
passed into the request. This method’s token is pre-determined and
supplied by the credential. Passing in the key via query parameters
or in the payload is **not** supported.

To use API Key you must select ``API Key Authentication`` as the
value for the ``Authentication Type`` dropdown.

.. image:: ../../_static/authentication/images/example_api_key_cred.png

If you have information prior to and/or after the token, you must specify
it using a prefix and/or suffix for the token. The format for the token
is ``<Prefix> <API Key> <Suffix>``.

The fields available with API Key Authentication are:

 * Authorization Header

     * This field describes the name of the header to be sent.
       Default: ``Authorization``. This field is required.

 * Prefix

    * This field is used if a prefix is required before the token.
      This field is optional.

 * Suffix

    * This field is used if a suffix is required after the token.
      This field is optional.

 * API Key

    * This field specifies the API Key that is used to make the request.
      This field is required.

Example
-------
You need to make a request to a web server that
requires a pre-defined API Key to be included in the header.
The web server requires the authentication request's header
to contain ``Authorization: CoolBeans``.

To configure API Key Authentication, the following fields are
required:

 * API Key: ``CoolBeans``

Example - Prefix/Suffix
-----------------------
You need to make a request to a web server that
requires a pre-defined API Key to be included in the header.
The web server requires the authentication request's header
to contain ``MyAuth: Cool CBToken Beans``.

To configure this authentication, the following fields are
required:

 * Authorization Header: ``MyAuth``
 * Prefix: ``Cool``
 * Suffix: ``Beans``
 * API Key: ``CBToken``