Skip to content

Commit 1cd69f7

Browse files
committed
Add notes
1 parent c2d4948 commit 1cd69f7

2 files changed

Lines changed: 43 additions & 43 deletions

File tree

README.ja.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Super-User は、`alice-the-admin@test.com` と `test` の値を持っていま
399399
400400
次の例では、Admin Super-User を使用してログインします :
401401
402-
#### :one: リクエスト:
402+
#### 1️⃣ リクエスト:
403403
404404
```console
405405
curl -iX POST \
@@ -452,7 +452,7 @@ Connection: keep-alive
452452
ることができます。`{{X-Auth-token}}``{{X-Subject-token}}` は、Alice が自分自
453453
身について問い合わせを行っている場合に同じ値に設定することができます。
454454

455-
#### :two: リクエスト:
455+
#### 2️⃣ リクエスト:
456456

457457
```console
458458
curl -X GET \
@@ -542,7 +542,7 @@ curl -X GET \
542542
`/v1/applications/{{application-id}}/pep_proxies` エンドポイントに POST リクエス
543543
トを送信します。
544544

545-
#### :three: リクエスト:
545+
#### 3️⃣ リクエスト:
546546

547547
```console
548548
curl -iX POST \
@@ -574,7 +574,7 @@ curl -iX POST \
574574
トを行うと、関連する PEP Proxy アカウントの詳細が返されます。`X-Auth-token` をヘ
575575
ッダに指定してしてください。
576576

577-
#### :four: リクエスト:
577+
#### 4️⃣ リクエスト:
578578

579579
```console
580580
curl -X GET \
@@ -602,7 +602,7 @@ PEP Proxy アカウントのパスワードを更新するには
602602
クエストを実行し、関連する PEP Proxy アカウントの詳細が返されます
603603
`X-Auth-token` をヘッダに指定してしてください。
604604

605-
#### :five: リクエスト:
605+
#### 5️⃣ リクエスト:
606606

607607
```console
608608
curl -X PATCH \
@@ -629,7 +629,7 @@ curl -X PATCH \
629629
エンドポイントに DELETE リクエストを行うことで削除できます。`X-Auth-token` をヘ
630630
ッダに指定してしてください。
631631

632-
#### :six: リクエスト:
632+
#### 6️⃣ リクエスト:
633633

634634
```console
635635
curl -X DELETE \
@@ -664,7 +664,7 @@ PEP Proxy 作成と同様に、サイン・インして、ユーザはアプリ
664664
`/v1/applications/{{application-id}}/iot_agents` エンドポイントに POST リクエス
665665
トを送信します。
666666

667-
#### :seven: リクエスト:
667+
#### 7️⃣ リクエスト:
668668

669669
```console
670670
curl -X POST \
@@ -696,7 +696,7 @@ GET リクエストを作成すると
696696
トは関連する IoT Agent アカウントの詳細を返します。`X-Auth-token` をヘッダに指定
697697
してしてください。
698698

699-
#### :eight: リクエスト:
699+
#### 8️⃣ リクエスト:
700700

701701
```console
702702
curl -X GET \
@@ -723,7 +723,7 @@ curl -X GET \
723723
を実行することによって、アプリケーションに関連するすべての IoT Agents のリストを
724724
得ることができる。`X-Auth-token` をヘッダに指定してしてください。
725725

726-
#### :nine: リクエスト:
726+
#### 9️⃣ リクエスト:
727727

728728
```console
729729
curl -X GET \
@@ -750,7 +750,7 @@ curl -X GET \
750750

751751
### IoT Agent のパスワードをリセット
752752

753-
#### :one::zero: リクエスト:
753+
#### 1️⃣0️⃣ リクエスト:
754754

755755
個々の IoT Agent アカウントのパスワードを更新するには
756756
`/v1/applications/{{application-id}}//iot_agents/{{iot-agent-id}}` エンドポイ
@@ -783,7 +783,7 @@ curl -iX PATCH \
783783
トに DELETE リクエストを行うことで削除できます。`X-Auth-token` をヘッダに指定し
784784
てしてください。
785785

786-
#### :one::one: リクエスト:
786+
#### 1️⃣1️⃣ リクエスト:
787787

788788
```console
789789
curl -X DELETE \
@@ -954,7 +954,7 @@ tutorial-app:
954954
Broker の前にあります。リクエストには、`X-Auth-Token` を含める必要があります。有
955955
効なトークンを提示できないと、アクセスが拒否されます。
956956

957-
#### :one::two: リクエスト:
957+
#### 1️⃣2️⃣ リクエスト:
958958

959959
以下のようにアクセス・トークンなしで PEP Proxy へのリクエストが行われた場合は :
960960

@@ -975,7 +975,7 @@ Auth-token not found in request header
975975

976976
### Keyrock - ユーザによるアクセス・トークンの取得
977977

978-
#### :one::three: リクエスト:
978+
#### 1️⃣3️⃣ リクエスト:
979979

980980
ユーザ・クレデンシャルのフローを使用してアプリケーションにログインするには
981981
、`oauth2/token` エンドポイントを使用して、`grant_type=password` とともに
@@ -1016,7 +1016,7 @@ curl -iX POST \
10161016
Proxy へのリクエストが行われた場合、そのリクエストは許可され、PEP Proxy の背後に
10171017
あるサービス (この場合は Orion Context Broker) が期待通りにデータを返します。
10181018

1019-
#### :one::four: リクエスト:
1019+
#### 1️⃣4️⃣ リクエスト:
10201020

10211021
```console
10221022
curl -X GET \
@@ -1051,7 +1051,7 @@ curl -X GET \
10511051
標準の `Authorization: Bearer` ヘッダを使用してユーザを識別することもできます。承認されたユーザからのリクエストが許可
10521052
され、PEP Proxy の背後にあるサービス (この場合は Orion Context Broker) が期待どおりにデータを返します。
10531053

1054-
#### :one::five: リクエスト:
1054+
#### 1️⃣5️⃣ リクエスト:
10551055

10561056
```console
10571057
curl -X GET \
@@ -1303,7 +1303,7 @@ IoT センサとしてのログインは、ユーザと同じユーザ・クレ
13031303
POST リクエストを送ります :
13041304

13051305

1306-
#### :one::five: リクエスト:
1306+
#### 1️⃣5️⃣ リクエスト:
13071307

13081308
```console
13091309
curl -iX POST \
@@ -1339,7 +1339,7 @@ Ultralight IoT Agent の前にある PEP Proxy への POST リクエストは、
13391339
定値を渡します。`X-Auth-Token` ヘッダを追加すると、リクエスト元が Keyrock に登録
13401340
されていると識別され、測定が IoT Agent 自体に正常に渡されます。
13411341

1342-
#### :one::six: リクエスト:
1342+
#### 1️⃣6️⃣ リクエスト:
13431343

13441344
```console
13451345
curl -X POST \
@@ -1483,7 +1483,7 @@ Keyrock アプリケーションは、永久トークンを提供するように
14831483
`scope=permanent` が追加され、利用可能な場合に永続トークンを取得します。レスポンスには、デバイスのプロビジョニングに
14841484
使用できる `access_token` が含まれています。
14851485

1486-
#### :one::seven: リクエスト:
1486+
#### 1️⃣7️⃣ リクエスト:
14871487

14881488
```console
14891489
curl -X POST \
@@ -1520,7 +1520,7 @@ curl -X POST \
15201520
}
15211521
```
15221522

1523-
#### :one::eight: リクエスト:
1523+
#### 1️⃣8️⃣ リクエスト:
15241524

15251525
```console
15261526
curl -iX PUT \
@@ -1542,7 +1542,7 @@ curl -iX PUT \
15421542

15431543
信頼できるサービス・グループが作成されると、通常の方法でデバイスをプロビジョニングできます。
15441544

1545-
#### :one::nine: リクエスト:
1545+
#### 1️⃣9️⃣ リクエスト:
15461546

15471547
```console
15481548
curl -iX POST \

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ and `test`. The URL `https://localhost:3443/v1/auth/tokens` should also work in
330330
331331
The following example logs in using the Admin Super-User:
332332
333-
#### :one: Request:
333+
#### 1️⃣ Request:
334334
335335
```console
336336
curl -iX POST \
@@ -379,7 +379,7 @@ You can use the long-lasting `X-Auth-token=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`
379379
tutorial. Both `{{X-Auth-token}}` and `{{X-Subject-token}}` can be set to the same value in the case that Alice is
380380
making an enquiry about herself.
381381

382-
#### :two: Request:
382+
#### 2️⃣ Request:
383383

384384
```console
385385
curl -X GET \
@@ -452,7 +452,7 @@ To create a new PEP Proxy account within an application, send a POST request to
452452
`/v1/applications/{{application-id}}/pep_proxies` endpoint along with the `X-Auth-token` header from a previously logged
453453
in administrative user.
454454

455-
#### :three: Request:
455+
#### 3️⃣ Request:
456456

457457
```console
458458
curl -iX POST \
@@ -480,7 +480,7 @@ created with a unique `id` and `password` and the values will be returned in the
480480
Making a GET request to the `/v1/applications/{{application-id}}/pep_proxies` endpoint will return the details of the
481481
associated PEP Proxy Account. The `X-Auth-token` must be supplied in the headers.
482482

483-
#### :four: Request:
483+
#### 4️⃣ Request:
484484

485485
```console
486486
curl -X GET \
@@ -505,7 +505,7 @@ To renew the password of a PEP Proxy Account, make a PATCH request to the
505505
`/v1/applications/{{application-id}}/pep_proxies` endpoint will return the details of the associated PEP Proxy Account.
506506
The `X-Auth-token` must be supplied in the headers.
507507

508-
#### :five: Request:
508+
#### 5️⃣ Request:
509509

510510
```console
511511
curl -X PATCH \
@@ -529,7 +529,7 @@ The response returns a new password for the PEP Proxy Account
529529
An existing PEP Proxy Account can be deleted by making a DELETE request to the
530530
`/v1/applications/{{application-id}}/pep_proxies` endpoint. The `X-Auth-token` must be supplied in the headers.
531531

532-
#### :six: Request:
532+
#### 6️⃣ Request:
533533

534534
```console
535535
curl -X DELETE \
@@ -558,7 +558,7 @@ To create a new IoT Agent account within an application, send a POST request to
558558
`/v1/applications/{{application-id}}/iot_agents` endpoint along with the `X-Auth-token` header from a previously logged
559559
in administrative user.
560560

561-
#### :seven: Request:
561+
#### 7️⃣ Request:
562562

563563
```console
564564
curl -X POST \
@@ -585,7 +585,7 @@ A new account will be created with a unique `id` and `password` and the values w
585585
Making a GET request the `/v1/applications/{{application-id}}/iot_agents/{{iot-agent-id}}` endpoint will return the
586586
details of the associated IoT Agent Account. The `X-Auth-token` must be supplied in the headers.
587587

588-
#### :eight: Request:
588+
#### 8️⃣ Request:
589589

590590
```console
591591
curl -X GET \
@@ -609,7 +609,7 @@ curl -X GET \
609609
A list of all IoT Agents associated with an application can be obtained by making a GET request the
610610
`/v1/applications/{{application-id}}/iot_agents` endpoint. The `X-Auth-token` must be supplied in the headers.
611611

612-
#### :nine: Request:
612+
#### 9️⃣ Request:
613613

614614
```console
615615
curl -X GET \
@@ -634,7 +634,7 @@ curl -X GET \
634634

635635
### Reset Password of an IoT Agent
636636

637-
#### :one::zero: Request:
637+
#### 1️⃣0️⃣ Request:
638638

639639
To renew the password of an individual IoT Agent Account, make a PATCH request to the
640640
`/v1/applications/{{application-id}}//iot_agents/{{iot-agent-id}}` endpoint. The `X-Auth-token` must be supplied in the
@@ -663,7 +663,7 @@ An existing IoT Agent Account can be deleted by making a DELETE request to the
663663
`/v1/applications/{{application-id}}/iot_agents/{{iot-agent-id}}` endpoint. The `X-Auth-token` must be supplied in the
664664
headers.
665665

666-
#### :one::one: Request:
666+
#### 1️⃣1️⃣ Request:
667667

668668
```console
669669
curl -X DELETE \
@@ -814,7 +814,7 @@ Secured Access can be ensured by requiring all requests to the secured service a
814814
this case the PEP Proxy is found in front of the Context Broker). Requests must include an `X-Auth-Token`, failure to
815815
present a valid token results in a denial of access.
816816

817-
#### :one::two: Request:
817+
#### 1️⃣2️⃣ Request:
818818

819819
If a request to the PEP Proxy is made without any access token as shown:
820820

@@ -833,7 +833,7 @@ Auth-token not found in request header
833833

834834
### Keyrock - User Obtains an Access Token
835835

836-
#### :one::three: Request:
836+
#### 1️⃣3️⃣ Request:
837837

838838
To log in to the application using the user-credentials flow send a POST request to **Keyrock** using the `oauth2/token`
839839
endpoint with the `grant_type=password`. For example to log-in as Alice the Admin:
@@ -869,7 +869,7 @@ If a request to the PEP Proxy is made including a valid access token in the `X-A
869869
is permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as
870870
expected.
871871

872-
#### :one::four: Request:
872+
#### 1️⃣4️⃣ Request:
873873

874874
```console
875875
curl -X GET \
@@ -883,7 +883,7 @@ The standard `Authorization: Bearer` header can also be used to identity the use
883883
is permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as
884884
expected.
885885

886-
#### :one::five: Request:
886+
#### 1️⃣5️⃣ Request:
887887

888888
```console
889889
curl -X GET \
@@ -1066,7 +1066,7 @@ this case Kong is acting as a PEP Proxy is found in front of the Context Broker)
10661066
Successful requests must include an `Authentiction` header, failure to present a valid token results in a denial of
10671067
access.
10681068

1069-
#### :one::six: Request:
1069+
#### 1️⃣6️⃣ Request:
10701070

10711071
If a request to the PEP Proxy is made without any access token as shown:
10721072

@@ -1085,7 +1085,7 @@ Request forbidden by authorization service Keyrock.
10851085

10861086
### Keyrock - User Obtains an Access Token
10871087

1088-
#### :one::seven: Request:
1088+
#### 1️⃣7️⃣ Request:
10891089

10901090
To log in to the application using the user-credentials flow send a POST request to **Keyrock** using the `oauth2/token`
10911091
endpoint with the `grant_type=password`. For example to log-in as Alice the Admin:
@@ -1121,7 +1121,7 @@ If a request to the PEP Proxy is made including a valid access token in the `X-A
11211121
is permitted and the service behind the PEP Proxy (in this case the Orion Context Broker) will return the data as
11221122
expected.
11231123

1124-
#### :one::eight: Request:
1124+
#### 1️⃣8️⃣ Request:
11251125

11261126
```console
11271127
curl -X GET \
@@ -1290,7 +1290,7 @@ Logging in as an IoT Sensor follows the same user-credentials flow as for a User
12901290
`iot_sensor_00000000-0000-0000-0000-000000000000` with password `test` send a POST request to **Keyrock** using the
12911291
`oauth2/token` endpoint with the `grant_type=password`:
12921292

1293-
#### :one::five: Request:
1293+
#### 1️⃣5️⃣ Request:
12941294

12951295
```console
12961296
curl -iX POST \
@@ -1323,7 +1323,7 @@ The POST request to a PEP Proxy in front to the Ultralight IoT Agent identifies
13231323
the source of the request as being registered in Keyrock, and therefore the measurement will be successfully passed on
13241324
to the IoT Agent itself.
13251325

1326-
#### :one::nine: Request:
1326+
#### 1️⃣9️⃣ Request:
13271327

13281328
```console
13291329
curl -X POST \
@@ -1454,7 +1454,7 @@ The standard `Authorization: Basic` header holds the base 64 concatentation of t
14541454
`scope=permanent` is added to retrieve permanent tokens when available. The response contains an `access_token` which
14551455
can be used for device provisioning.
14561456

1457-
#### :two::zero: Request:
1457+
#### 2️⃣0️⃣ Request:
14581458

14591459
```console
14601460
curl -X POST \
@@ -1489,7 +1489,7 @@ been provisioned as shown:
14891489
}
14901490
```
14911491

1492-
#### :two::one: Request:
1492+
#### 2️⃣1️⃣ Request:
14931493

14941494
> **Note:** use the `access_token` from the previous request.
14951495

@@ -1511,7 +1511,7 @@ The Motion sensor requests are now sent via the `orion-proxy` and identify thems
15111511

15121512
Once a trusted service group has been created, a device can be provisioned in the usual manner
15131513

1514-
#### :two::two: Request:
1514+
#### 2️⃣2️⃣ Request:
15151515

15161516
```console
15171517
curl -iX POST \

0 commit comments

Comments
 (0)