pekko/akka-docs/rst/scala/http/routing-dsl/directives/security-directives/extractCredentials.rst

.. _-extractCredentials-:

extractCredentials
==================

Signature
---------

.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala
   :snippet: extractCredentials

Description
-----------

Extracts the potentially present ``HttpCredentials`` provided with the request's ``Authorization`` header,
which can be then used to implement some custom authentication or authorization logic.

See :ref:`credentials-and-timing-attacks-scala` for details about verifying the secret.

Example
-------

.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/SecurityDirectivesExamplesSpec.scala
   :snippet: 0extractCredentials
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`.. _-extractCredentials-:`

			`extractCredentials`
			`==================`

			`Signature`
			`---------`

=doc fix broken links in scala-side HTTP docs 2015-06-19 15:35:24 +02:00			`.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: extractCredentials`

			`Description`
			`-----------`

+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			Extracts the potentially present ``HttpCredentials`` provided with the request's ``Authorization`` header,
			`which can be then used to implement some custom authentication or authorization logic.`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
=doc #18857 Add docs about comparing the secret when authenticating 2015-11-19 11:08:37 +01:00			See :ref:`credentials-and-timing-attacks-scala` for details about verifying the secret.

=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`Example`
			`-------`

=doc #18104 fixes typo which made includecode2 not work in many places Note that some of the files don't exist, fixing this very soon. 2015-09-16 23:50:35 +02:00			`.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/SecurityDirectivesExamplesSpec.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: 0extractCredentials`