Skip to content

Commit 17e8dc8

Browse files
committed
Add query params authentication docs
1 parent f5c18a1 commit 17e8dc8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/components/authentication.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,26 @@ $authentication = Matching::createUrlMatcher(new AuthenticationMethod(), '\/api'
123123
```
124124

125125

126+
### Query Params
127+
128+
Add authentication details as URL Query params:
129+
130+
`http://api.example.com/endpoint?access_token=9zh987g86fg87gh978hg9g79`
131+
132+
133+
``` php
134+
use Http\Authentication\QueryParams;
135+
136+
$authentication = new QueryParams([
137+
'access_token' => '9zh987g86fg87gh978hg9g79',
138+
]);
139+
```
140+
141+
!!! warning "Warning:"
142+
Using query parameters for authentication is not safe.
143+
Only use it when absolutely necessary.
144+
145+
126146
### WSSE
127147

128148
This method implements [WSSE Authentication](http://www.xml.com/pub/a/2003/12/17/dive.html).

0 commit comments

Comments
 (0)