Skip to content

Commit bf1bcac

Browse files
committed
Add notes
1 parent 12854e2 commit bf1bcac

2 files changed

Lines changed: 16 additions & 15 deletions

File tree

README.ja.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ dHV0b3JpYWwtZGNrci1zaXRlLTAwMDAteHByZXNzd2ViYXBwOnR1dG9yaWFsLWRja3Itc2l0ZS0wMDAw
502502
503503
### パスワードによるログイン
504504
505-
#### :one: リクエスト
505+
#### 1️⃣ リクエスト
506506
507507
ユーザ資格情報フローを使用してログインするには、POST リクエストを
508508
`grant_type=password` を指定して、`oauth2/token` エンドポイントに送信します。
@@ -537,7 +537,7 @@ curl -iX POST \
537537
リクエストと共に使用することができます。例えば、上記のレスポンスから
538538
`access_token` を取得します。
539539

540-
#### :two: リクエスト
540+
#### 2️⃣ リクエスト
541541

542542
```console
543543
curl -G -X GET \
@@ -782,7 +782,7 @@ function implicitGrantCallback(req, res) {
782782
`grant_type=client_credentials` を指定して、`oauth2/token` エンドポイントに送
783783
信します。
784784

785-
#### :three: リクエスト
785+
#### 3️⃣ リクエスト
786786

787787
```console
788788
curl -iX POST \
@@ -851,7 +851,7 @@ function clientCredentialGrant(req, res) {
851851
ローを使用してログインする場合は、`grant_type=password` を使って POST リクエスト
852852
`oauth2/token` エンドポイントに送ります。
853853

854-
#### :four: Request
854+
#### 4️⃣ Request
855855

856856
```console
857857
curl -iX POST \
@@ -885,7 +885,7 @@ curl -iX POST \
885885
えば、前回の有効期限が過ぎると)、`refresh_token` が OAuth2 リフレッシュ・トーク
886886
ンのフローと `grant_type=refresh_token` で使われます。
887887

888-
#### :five: リクエスト
888+
#### 5️⃣ リクエスト
889889

890890
```console
891891
curl -iX POST \
@@ -980,7 +980,7 @@ PDP アクセス制御には 3 つのレベルがあります :
980980
ユーザが **Keyrock** を使用して認証した場合、`/user` エンドポイントに GET リクエ
981981
ストを行うことでアクセス・トークンの最新性を確認できます。
982982

983-
#### :six: リクエスト
983+
#### 6️⃣ リクエスト
984984

985985
```console
986986
curl -X GET \
@@ -1041,7 +1041,7 @@ function pdpAuthentication(req, res, next) {
10411041
`action` に基づいています。`/user` GET リクエストにパラメータを追加することで、
10421042
アクセス・パーミッションを含む拡張されたユーザの詳細を取得できます。
10431043

1044-
#### :seven: リクエスト
1044+
#### 7️⃣ リクエスト
10451045

10461046
```console
10471047
curl -X GET \

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,8 @@ repository:
285285
./services start
286286
```
287287

288-
> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command:
288+
> [!NOTE]
289+
> If you want to clean up and start over again you can do so with the following command:
289290
>
290291
> ```console
291292
> ./services stop
@@ -399,7 +400,7 @@ diagram, the user must type their own password into the web-app client itself
399400
400401
### Logging-in with a Password
401402
402-
#### :one: Request
403+
#### 1️⃣ Request
403404
404405
To log in using the user-credentials flow send a POST request to the `oauth2/token` endpoint with the
405406
`grant_type=password`
@@ -433,7 +434,7 @@ The response returns an `access_token` to identify the user:
433434
The access code can then be used with a GET request to the `/user` endpoint to obtain user details, for example, taking
434435
the `access_token` from the response above
435436

436-
#### :two: Request
437+
#### 2️⃣ Request
437438

438439
```console
439440
curl -G -X GET \
@@ -637,7 +638,7 @@ been included for completeness.
637638
To log in using the client credentials flow send a POST request to the `oauth2/token` endpoint with the
638639
`grant_type=client_credentials`
639640

640-
#### :three: Request:
641+
#### 3️⃣ Request:
641642

642643
```console
643644
curl -iX POST \
@@ -689,7 +690,7 @@ appropriate for all grant types.
689690

690691
### Availability Check
691692

692-
#### :four: Request
693+
#### 4️⃣ Request
693694

694695
Check to see if Refresh Token flow is available, merely log in using one of the other grant types, for example to log in
695696
using the user-credentials flow send a POST request to the `oauth2/token` endpoint with the `grant_type=password`
@@ -722,7 +723,7 @@ The `refresh_token=05e386edd9f95ed0e599c5004db8573e86dff874` from the response a
722723
a new `access_token` (for example once the previous one has expired) the `refresh_token` is used in the OAuth2 refresh
723724
token flow and a `grant_type=refresh_token`
724725

725-
#### :five: Request
726+
#### 5️⃣ Request
726727

727728
```console
728729
curl -iX POST \
@@ -800,7 +801,7 @@ Level 1 PDP can be used in conjunction with any OAuth2 provider using any flow.
800801
If a user has authenticated using **Keyrock**, the freshness of the access token can be checked by making a GET request
801802
to the `/user` endpoint.
802803

803-
#### :six: Request
804+
#### 6️⃣ Request
804805

805806
```console
806807
curl -X GET \
@@ -854,7 +855,7 @@ As a reminder, **Keyrock** permissions are based on `resource` (e.g. URL) and `a
854855
verb). We can retrieve extended user details including access permissions by adding additional parameters to a `/user`
855856
GET request
856857

857-
#### :seven: Request
858+
#### 7️⃣ Request
858859

859860
```console
860861
curl -X GET \

0 commit comments

Comments
 (0)