.. _envoy_api_file_envoy/service/auth/v2alpha/external_auth.proto:

Authorization Service 
======================

The authorization service request messages used by external authorization :ref:`network filter
<config_network_filters_ext_authz>` and :ref:`HTTP filter <config_http_filters_ext_authz>`.

.. _envoy_api_msg_service.auth.v2alpha.CheckRequest:

service.auth.v2alpha.CheckRequest
---------------------------------

`[service.auth.v2alpha.CheckRequest proto] <https://github.com/envoyproxy/envoy/blob/master/api/envoy/service/auth/v2alpha/external_auth.proto#L24>`_


.. code-block:: json

  {
    "attributes": "{...}"
  }

.. _envoy_api_field_service.auth.v2alpha.CheckRequest.attributes:

attributes
  (:ref:`service.auth.v2alpha.AttributeContext <envoy_api_msg_service.auth.v2alpha.AttributeContext>`) The request attributes.
  
  


.. _envoy_api_msg_service.auth.v2alpha.CheckResponse:

service.auth.v2alpha.CheckResponse
----------------------------------

`[service.auth.v2alpha.CheckResponse proto] <https://github.com/envoyproxy/envoy/blob/master/api/envoy/service/auth/v2alpha/external_auth.proto#L29>`_


.. code-block:: json

  {
    "status": "{...}"
  }

.. _envoy_api_field_service.auth.v2alpha.CheckResponse.status:

status
  (`Status <https://cloud.google.com/natural-language/docs/reference/rpc/google.rpc#status>`_) Status `OK` allows the request. Any other status indicates the request should be denied.
  
  
.. _envoy_api_msg_service.auth.v2alpha.CheckResponse.HttpResponse:

service.auth.v2alpha.CheckResponse.HttpResponse
-----------------------------------------------

`[service.auth.v2alpha.CheckResponse.HttpResponse proto] <https://github.com/envoyproxy/envoy/blob/master/api/envoy/service/auth/v2alpha/external_auth.proto#L36>`_

An optional message that contains HTTP response attributes. This message is
used when the authorization service needs to send custom responses to the
downstream client or, to modify/add request headers being dispatched to the upstream.

.. code-block:: json

  {
    "status_code": "...",
    "headers": "{...}",
    "body": "..."
  }

.. _envoy_api_field_service.auth.v2alpha.CheckResponse.HttpResponse.status_code:

status_code
  (`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Http status code.
  
  
.. _envoy_api_field_service.auth.v2alpha.CheckResponse.HttpResponse.headers:

headers
  (map<`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, `string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_>) Http entity headers.
  
  
.. _envoy_api_field_service.auth.v2alpha.CheckResponse.HttpResponse.body:

body
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Http entity body.