.. _step-QueryRestOAuth:


QueryRestOAuth
==============

Make RESTful request to an endpoint with OAuth

.. versionadded:: 1.0.0

* **Friendly name:** ``QueryRest: OAuth``
* **Step class:** ``base_steps_syncpack.steps.QueryRestOAuth.QueryRestOAuth``
* **Step version:** ``1.1.0``
* **Required parameters:** ``client_id``, ``client_secret``, ``token_url``, ``method``, ``prefix_url``

Parameters
----------

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

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``client_id``
     - string
     - yes
     - --
     - OAuth2 Client ID
   * - ``client_secret``
     - string
     - yes
     - --
     - OAuth2 Client secret
   * - ``token_url``
     - string
     - yes
     - --
     - Full authentication URL including host and protocol.
   * - ``revoke_url``
     - string
     - no
     - --
     - Optional Full Token Revocation URL including host and protocol.
   * - ``use_basic_auth``
     - boolean
     - no
     - ``False``
     - Enable if your provider requires that you pass auth credentials in a Basic Auth Header
   * - ``refresh_token``
     - string (long)
     - no
     - --
     - Populate if the call needs to use a refresh token.
   * - ``scopes``
     - array of strings
     - no
     - ``[]``
     - List of OAuth2 Scopes to apply
   * - ``additional_auth_arguments``
     - json
     - no
     - ``{}``
     - Additional key-value pairs to pass to the authentication form.

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:** ``QueryRestOAuth`` -> ``QueryREST`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.steps.QueryREST``
* **External packages:** ``ipaascommon``, ``ipaascore``, ``isbaseutils``, ``oauthlib``, ``requests``, ``requests_oauthlib``

.. include:: /_step_notes/QueryRestOAuth.rst

API
---

.. autoclass:: base_steps_syncpack.steps.QueryRestOAuth.QueryRestOAuth
   :members:
   :show-inheritance: