.. _step-QueryRestBearerAuth:


QueryRestBearerAuth
===================

Make RESTful request to an endpoint with BearerAuth

.. versionadded:: 1.0.0

* **Friendly name:** ``QueryRest: BearerAuth``
* **Step class:** ``base_steps_syncpack.steps.QueryRestBearerAuth.QueryRestBearerAuth``
* **Step version:** ``1.0.0``
* **Required parameters:** ``method``, ``prefix_url``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``bearer_token``
     - string
     - no
     - --
     - Token for authorization

Required inherited parameters
-----------------------------

These are defined on :ref:`step-QueryREST` but are **required** here, so a
working configuration must set them.

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``method``
     - enum
     - yes
     - --
     - HTTP method to perform Example: ``GET``
   * - ``prefix_url``
     - string
     - yes
     - --
     - used with relative_url to create the full URL. Example: ``http://host.example.com``

Other inherited parameters
--------------------------

This step also accepts 20 optional parameter(s) inherited from
:ref:`step-QueryREST`.

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``QueryRestBearerAuth`` -> ``QueryREST`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.steps.QueryREST``
* **External packages:** ``ipaascore``

.. include:: /_step_notes/QueryRestBearerAuth.rst