From eef5089f75e612fc25736cb7875cba8285397619 Mon Sep 17 00:00:00 2001 From: Jason Fox Date: Mon, 18 Dec 2023 11:33:04 +0100 Subject: [PATCH] Add notes --- README.ja.md | 22 +++++++++++----------- README.md | 25 +++++++++++++------------ 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/README.ja.md b/README.ja.md index 79f3344..2a33907 100644 --- a/README.ja.md +++ b/README.ja.md @@ -583,7 +583,7 @@ Bash スクリプトを実行することによって、コマンドラインか 場合、これは通常 **Authzforce** が実行されていないか別のポートで待機している ためです。 -#### :one: リクエスト +#### 1️⃣ リクエスト ```console curl -X GET \ @@ -644,7 +644,7 @@ API を提供する必要があります。このチュートリアルは主に **Authzforce** にドメイン情報をリクエストするには、 `/authzforce-ce/domains` エンドポイントにリクエストを出します。 -#### :two: リクエスト +#### 2️⃣ リクエスト ```console curl -X GET \ @@ -678,7 +678,7 @@ curl -X GET \ この場合、**Keyrock** が PAP として使用され、 ルールセットが事前に生成されています。 -#### :three: リクエスト +#### 3️⃣ リクエスト ```console curl -X GET \ @@ -716,7 +716,7 @@ curl -X GET \ リクエストを出します。次のリクエストは、`gQqnLOnIEeiBFQJCrBIBDA` ドメイン内で見つかった特定ポリシーの ids のリストを取得します。 -#### :four: リクエスト +#### 4️⃣ リクエスト ```console curl -X GET \ @@ -752,7 +752,7 @@ curl -X GET \ 次のリクエストは、`gQqnLOnIEeiBFQJCrBIBDA` ドメイン内で見つかった特定ポリシー のリビジョンのリストを取得します。 -#### :five: リクエスト +#### 5️⃣ リクエスト ```console curl -X GET \ @@ -786,7 +786,7 @@ curl -X GET \ エンドポイントにリクエストを出します。次のリクエストは、`gQqnLOnIEeiBFQJCrBIBDA` ドメイン内で見つかった特定のポリシーの2番目のリビジョンを取得します。 -#### :six: リクエスト +#### 6️⃣ リクエスト ```console curl -X GET \ @@ -861,7 +861,7 @@ GET リクエスト) などの情報が含まれています。明らかに、 `managers-role-0000-0000-000000000000` を持ち、 リソース `/app/price-change` へのアクセスをリクエストしています。 -#### :seven: リクエスト +#### 7️⃣ リクエスト ```console curl -X POST \ @@ -920,7 +920,7 @@ curl -X POST \ を持ち、リソース `/app/price-change` へのアクセスをリクエスト しています。 -#### :eight: リクエスト +#### 8️⃣ リクエスト ```console curl -X POST \ @@ -1025,7 +1025,7 @@ PEP Proxy の背後に隠されています。リクエストが Orion に行わ を指定して **Keyrock** の `oauth2/token` エンドポイントに POST リクエストを送信します。 -#### :nine: リクエスト +#### 9️⃣ リクエスト ```console curl -X POST \ @@ -1059,7 +1059,7 @@ curl -X POST \ リソースへのアクセス許可を得るために使用できます。 この例では、特定のリソースに対する Bob の権限を取得します。 -#### :one::zero: リクエスト +#### 1️⃣0️⃣ リクエスト ```console curl -X GET \ @@ -1116,7 +1116,7 @@ curl -X GET \ id (`tutorial-dckr-site-0000-xpresswebapp`)、リクエストされている HTTP 動詞と リソース (`/v2/entities` URL に対する POST リクエスト) などの情報が含まれます。 -#### :one::one: リクエスト +#### 1️⃣1️⃣ リクエスト ```console curl -X POST \ diff --git a/README.md b/README.md index cf6a2b1..574acd8 100644 --- a/README.md +++ b/README.md @@ -454,7 +454,8 @@ repository: ./services start ``` -> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command: +> [!NOTE] +> If you want to clean up and start over again you can do so with the following command: > > ```console > ./services stop @@ -507,7 +508,7 @@ Once **Authzforce** is running, you can check the status by making an HTTP reque (usually `8080`). If the response is blank, this is usually because **Authzforce** is not running or is listening on another port. -#### :one: Request +#### 1️⃣ Request ```console curl -X GET \ @@ -556,7 +557,7 @@ can be used to query **Authzforce** about the domains served and policies held. To request domain information from **Authzforce**, make a request to the `/authzforce-ce/domains` endpoint. -#### :two: Request +#### 2️⃣ Request ```console curl -X GET \ @@ -588,7 +589,7 @@ endpoint. The following request obtains information about the `gQqnLOnIEeiBFQJCr using a random key by an external Policy Administration Point in this case **Keyrock** has been used as the PAP, and pre-generated the rule sets. -#### :three: Request +#### 3️⃣ Request ```console curl -X GET \ @@ -624,7 +625,7 @@ To list the generated IDs for all of the PolicySets found within a domain make a `authzforce-ce/domains/{{domain-id}}/pap/policies` endpoint. The following request obtains a list of a given policy IDs found within the `gQqnLOnIEeiBFQJCrBIBDA` domain. -#### :four: Request +#### 4️⃣ Request ```console curl -X GET \ @@ -657,7 +658,7 @@ To list the available revisions of a policy, make a request to the and can be obtained by drilling down using the previous request. The following request obtains a list revision of a given policy found within the `gQqnLOnIEeiBFQJCrBIBDA` domain. -#### :five: Request +#### 5️⃣ Request ```console curl -X GET \ @@ -689,7 +690,7 @@ To obtain a single revision of a ``, make a request to the `authzforce-ce/domains/{{domain-id}}/pap/policies/{{policy-id}}/{{revision-number}}` endpoint. The following request obtains the second revision of the given policy found within the `gQqnLOnIEeiBFQJCrBIBDA` domain. -#### :six: Request +#### 6️⃣ Request ```console curl -X GET \ @@ -758,7 +759,7 @@ the Body can be expanded as the rules become more complex. To request a decision from Authzforce, make a POST request to the `domains/{domain-id}/pdp` endpoint. In this case the user has the `managers-role-0000-0000-000000000000` and is requesting access the `/app/price-change` resource. -#### :seven: Request +#### 7️⃣ Request ```console curl -X POST \ @@ -813,7 +814,7 @@ successful request includes a `` element to `Permit` access to the res To request a decision from Authzforce, make a POST request to the `domains/{domain-id}/pdp` endpoint. In this case the user has the `security-role-0000-0000-000000000000` and is requesting access the `/app/price-change` resource. -#### :eight: Request +#### 8️⃣ Request ```console curl -X POST \ @@ -898,7 +899,7 @@ OAuth2 access grants described in a [previous tutorial](https://github.com/FIWAR To log in using the user-credentials flow send a POST request to the `oauth2/token` endpoint of **Keyrock** with the `grant_type=password` -#### :nine: Request +#### 9️⃣ Request ```console curl -X POST \ @@ -928,7 +929,7 @@ The response returns an `access_token` to identify the user (in this case Bob th If a user has logged in, the `access_token` can be used in combination with the `/user` endpoint to obtain access permissions to a resource. This example retrieves Bob's permissions to a given resource. -#### :one::zero: Request +#### 1️⃣0️⃣ Request ```console curl -X GET \ @@ -979,7 +980,7 @@ the User has (`managers-role-0000-0000-000000000000`), the application ID that i (`tutorial-dckr-site-0000-xpresswebapp`) and the HTTP verb and resource that are being requested ( a POST request on the `/v2/entities` URL) -#### :one::one: Request +#### 1️⃣1️⃣ Request ```console curl -X POST \