Skip to content

Commit da3d337

Browse files
authored
Fixed API domainname and write missing comma (#145)
1 parent 3baaab0 commit da3d337

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/guide/api.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -384,14 +384,14 @@ The request must include all three fields.
384384
- `timeToLive`: (OPTIONAL) Number of seconds the magic link token should be valid for. If not set, the default value is 1 hour.
385385

386386
```http request
387-
POST https://v4.passwwordless.dev/magic-links/send HTTP/1.1
387+
POST https://v4.passwordless.dev/magic-links/send HTTP/1.1
388388
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
389389
Content-Type: application/json
390390
391391
{
392392
"emailAddress": "[email protected]",
393-
"urlTemplate": "https://www.myapp.com?token=$TOKEN"
394-
"userId": "c8a32e5b-46d3-4808-ae10-16d3e26ff6f9"
393+
"urlTemplate": "https://www.myapp.com?token=$TOKEN",
394+
"userId": "c8a32e5b-46d3-4808-ae10-16d3e26ff6f9",
395395
"timeToLive": 3600
396396
}
397397
```
@@ -409,12 +409,12 @@ If Magic Links has not been enabled, the `/magic-links/send` endpoint will retur
409409
`GET` requests made to the `/auth-configs/list` endpoint will return a `.json` object containing a list of authentication configurations that can be used by the application. It can be filtered to one specific configuration by passing the purpose name as a query parameter.
410410

411411
```http request
412-
GET https://v4.passwwordless.dev/auth-configs/list HTTP/1.1
412+
GET https://v4.passwordless.dev/auth-configs/list HTTP/1.1
413413
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
414414
```
415415

416416
```http request
417-
GET https://v4.passwwordless.dev/auth-configs/list?purpose=step-up HTTP/1.1
417+
GET https://v4.passwordless.dev/auth-configs/list?purpose=step-up HTTP/1.1
418418
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
419419
```
420420

@@ -463,14 +463,14 @@ If successful, the `/auth-configs/list` endpoint will return a `.json` object co
463463
- `performedBy`: user identifier to track changes to the configuration
464464

465465
```http request
466-
GET https://v4.passwwordless.dev/auth-configs/add HTTP/1.1
466+
GET https://v4.passwordless.dev/auth-configs/add HTTP/1.1
467467
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
468468
Content-Type: application/json
469469
470470
{
471471
"purpose": "access-secrets-purpose", // identifying string give context to the specific authentication
472472
"timeToLive": "00:03:00", // timespan the token is valid for
473-
"userVerificationRequirement": "preferred" // requirement for if the user has to verify they're allowed to use an authenticator
473+
"userVerificationRequirement": "preferred", // requirement for if the user has to verify they're allowed to use an authenticator
474474
"performedBy": "user_123" // user identifier to track changes to the configuration
475475
}
476476
```
@@ -492,14 +492,14 @@ If unsuccessful, the `/auth-configs/add` endpoint will return an HTTP 400 (Bad R
492492
- `performedBy`: user identifier to track changes to the configuration
493493

494494
```http request
495-
GET https://v4.passwwordless.dev/auth-configs HTTP/1.1
495+
GET https://v4.passwordless.dev/auth-configs HTTP/1.1
496496
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
497497
Content-Type: application/json
498498
499499
{
500500
"purpose": "access-secrets-purpose", // existing purpose
501501
"timeToLive": "00:03:00", // timespan the token is valid for
502-
"userVerificationRequirement": "preferred" // requirement for if the user has to verify they're allowed to use an authenticator
502+
"userVerificationRequirement": "preferred", // requirement for if the user has to verify they're allowed to use an authenticator
503503
"performedBy": "user_123" // user identifier to track changes to the configuration
504504
}
505505
```
@@ -516,7 +516,7 @@ If an unknown purpose is passed through, the `/auth-configs` endpoint will retur
516516
`POST` requests made to the `/auth-configs/delete` endpoint delete a specific authentication configuration, as specified by a `purpose`.
517517

518518
```http request
519-
GET https://v4.passwwordless.dev/auth-configs/add HTTP/1.1
519+
GET https://v4.passwordless.dev/auth-configs/add HTTP/1.1
520520
ApiSecret: myapplication:secret:11f8dd7733744f2596f2a28544b5fbc4
521521
Content-Type: application/json
522522

0 commit comments

Comments
 (0)