Skip to content

Commit f008819

Browse files
committed
Use a more realistic /api instead of /admin
1 parent 81dd5e7 commit f008819

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

cookbook/security/api_key_authentication.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ value and then a User object is created::
9292

9393
Once you've :ref:`configured <cookbook-security-api-key-config>` everything,
9494
you'll be able to authenticate by adding an apikey parameter to the query
95-
string, like ``http://example.com/admin/foo?apikey=37b51d194a7513e45b56f6524f2d51f2``.
95+
string, like ``http://example.com/api/foo?apikey=37b51d194a7513e45b56f6524f2d51f2``.
9696

9797
The authentication process has several steps, and your implementation will
9898
probably differ:
@@ -354,7 +354,7 @@ using the ``simple_preauth`` and ``provider`` keys respectively:
354354
355355
firewalls:
356356
secured_area:
357-
pattern: ^/admin
357+
pattern: ^/api
358358
stateless: true
359359
simple_preauth:
360360
authenticator: apikey_authenticator
@@ -377,7 +377,7 @@ using the ``simple_preauth`` and ``provider`` keys respectively:
377377
<!-- ... -->
378378
379379
<firewall name="secured_area"
380-
pattern="^/admin"
380+
pattern="^/api"
381381
stateless="true"
382382
provider="api_key_user_provider"
383383
>
@@ -397,7 +397,7 @@ using the ``simple_preauth`` and ``provider`` keys respectively:
397397
$container->loadFromExtension('security', array(
398398
'firewalls' => array(
399399
'secured_area' => array(
400-
'pattern' => '^/admin',
400+
'pattern' => '^/api',
401401
'stateless' => true,
402402
'simple_preauth' => array(
403403
'authenticator' => 'apikey_authenticator',
@@ -412,7 +412,7 @@ using the ``simple_preauth`` and ``provider`` keys respectively:
412412
),
413413
));
414414
415-
If you have defined `access_control`, make sure to add new entry:
415+
If you have defined ``access_control``, make sure to add a new entry:
416416

417417
.. configuration-block::
418418

@@ -423,7 +423,7 @@ If you have defined `access_control`, make sure to add new entry:
423423
# ...
424424
425425
access_control:
426-
- { path: ^/admin, roles: ROLE_API }
426+
- { path: ^/api, roles: ROLE_API }
427427
428428
.. code-block:: xml
429429
@@ -435,9 +435,7 @@ If you have defined `access_control`, make sure to add new entry:
435435
xsi:schemaLocation="http://symfony.com/schema/dic/services
436436
http://symfony.com/schema/dic/services/services-1.0.xsd">
437437
438-
<rule path="^/admin"
439-
role="ROLE_API"
440-
/>
438+
<rule path="^/api" role="ROLE_API" />
441439
</srv:container>
442440
443441
.. code-block:: php
@@ -446,7 +444,7 @@ If you have defined `access_control`, make sure to add new entry:
446444
$container->loadFromExtension('security', array(
447445
'access_control' => array(
448446
array(
449-
'path' => '^/admin',
447+
'path' => '^/api',
450448
'role' => 'ROLE_API',
451449
),
452450
),
@@ -484,7 +482,7 @@ configuration or set it to ``false``:
484482
485483
firewalls:
486484
secured_area:
487-
pattern: ^/admin
485+
pattern: ^/api
488486
stateless: false
489487
simple_preauth:
490488
authenticator: apikey_authenticator
@@ -507,7 +505,7 @@ configuration or set it to ``false``:
507505
<!-- ... -->
508506
509507
<firewall name="secured_area"
510-
pattern="^/admin"
508+
pattern="^/api"
511509
stateless="false"
512510
provider="api_key_user_provider"
513511
>
@@ -526,7 +524,7 @@ configuration or set it to ``false``:
526524
$container->loadFromExtension('security', array(
527525
'firewalls' => array(
528526
'secured_area' => array(
529-
'pattern' => '^/admin',
527+
'pattern' => '^/api',
530528
'stateless' => false,
531529
'simple_preauth' => array(
532530
'authenticator' => 'apikey_authenticator',

0 commit comments

Comments
 (0)