Skip to content

Commit

Permalink
Add notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Dec 18, 2023
1 parent 0ad6348 commit 3bf27d8
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
36 changes: 18 additions & 18 deletions README.ja.md
Expand Up @@ -452,7 +452,7 @@ Unique Identifiers - UUIDs を使用します。
用するのと同じです。URL `https://localhost:3443/v1/auth/tokens` はセキュアなシス
テムでも動作するはずです。

#### :one: リクエスト :
#### 1️⃣ リクエスト :

```console
curl -iX POST \
Expand Down Expand Up @@ -508,7 +508,7 @@ Connection: keep-alive
**Keyrock** アプリケーション内には 1 人のユーザしかいません。 そのユーザは自分
自身について質問しています。

#### :two: リクエスト :
#### 2️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -552,7 +552,7 @@ curl -X GET \
`token` 値は、ユーザが初めてログオンしたときに
`d848eb12-889f-433b-9811-6a4fbf0b86ca` を取得しました :

#### :three: リクエスト :
#### 3️⃣ リクエスト :

```console
curl -iX POST \
Expand Down Expand Up @@ -656,7 +656,7 @@ REST API は、独自のやり取りをせずにユーザを作成したり修
ともに、ユーザ名、電子メール、パスワードを含む POST リクエストを `/v1/users`
ンドポイントに送信します。

#### :four: リクエスト :
#### 4️⃣ リクエスト :

```console
curl -iX POST \
Expand Down Expand Up @@ -796,7 +796,7 @@ curl -iX POST \
その id の下にリストされているユーザが返されます。`X-Auth-token` をヘッダに設定
してください。

#### :five: リクエスト :
#### 5️⃣ リクエスト :

To request

Expand Down Expand Up @@ -837,7 +837,7 @@ curl -X GET \
ザのみを返すことができます。ユーザのリストの取得は、`/v1/users` エンドポイントへ
の GET リクエストを行うことで実行できます。

#### :six: リクエスト :
#### 6️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -885,7 +885,7 @@ curl -X GET \
ザのみを返すことができます。ユーザのリストの取得は、`/v1/users` エンドポイントへ
の GET リクエストを行うことで実行できます。

#### :seven: リクエスト :
#### 7️⃣ リクエスト :

```console
curl -iX PATCH \
Expand Down Expand Up @@ -927,7 +927,7 @@ GUI 内で、ユーザは設定ページから自分のアカウントを削除
DELETE リクエストを `/v1/users/{{user-id}}` エンドポイントに送信することでこれを
実行できます。`X-Auth-token` ヘッダは、設定されなければなりません。

#### :eight: リクエスト :
#### 8️⃣ リクエスト :

```console
curl -iX DELETE \
Expand Down Expand Up @@ -991,7 +991,7 @@ HTTP 動詞 (POST, GET, PATCH および DELETE) に割り当てられます。
に、`name``description` を含む POST リクエストを `/v1/organizations` エンド
ポイントに送信します。

#### :nine: リクエスト :
#### 9️⃣ リクエスト :

```console
curl -iX POST \
Expand Down Expand Up @@ -1030,7 +1030,7 @@ curl -iX POST \
エストを行うと、その id の下にリストされている組織が返されます。`X-Auth-token`
は、許可された組織のみが表示されるため、ヘッダに指定する必要があります。

#### :one::zero: リクエスト :
#### 1️⃣0️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -1064,7 +1064,7 @@ curl -X GET \
可されます。`/v1/organizations` エンドポイントへの GET リクエストを行うことで、
ユーザを取得することができます。

#### :one::one: リクエスト :
#### 1️⃣1️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -1111,7 +1111,7 @@ curl -X GET \
既存の組織の詳細を修正するために、PATCH リクエストを
`/v1/organizations/{{organization-id}}` エンドポイントに送信します。

#### :one::two: リクエスト :
#### 1️⃣2️⃣ リクエスト :

```console
curl -iX PATCH \
Expand Down Expand Up @@ -1145,7 +1145,7 @@ curl -iX PATCH \

### 組織を削除

#### :one::three: リクエスト :
#### 1️⃣3️⃣ リクエスト :

```console
curl -iX DELETE \
Expand Down Expand Up @@ -1176,7 +1176,7 @@ GUI を使用して組織にユーザを追加するには、まず既存の組
`<organization-id>``<user-id>` を含む PUT リクエストを作成し、ヘッダに
`X-Auth-Token` を使用して自分自身を識別する必要があります。

#### :one::four: リクエスト :
#### 1️⃣4️⃣ リクエスト :

```console
curl -iX PUT \
Expand Down Expand Up @@ -1207,7 +1207,7 @@ curl -iX PUT \
ストを作成してヘッダ内に `X-Auth-Token` を使用して自分自身を識別することによって
、新しいオーナーを作成することもできます。

#### :one::five: リクエスト :
#### 1️⃣5️⃣ リクエスト :

```console
curl -iX PUT \
Expand Down Expand Up @@ -1239,7 +1239,7 @@ curl -iX PUT \
`/v1/organizations/{{organization-id}}/users` エンドポイントに対して GET リク
エストを行うことで実行できます。

#### :one::six: リクエスト :
#### 1️⃣6️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -1277,7 +1277,7 @@ curl -X GET \
`/v1/organizations/{{organization-id}}/users/{{user-id}}/organization_roles`
エンドポイントに GET リクエストを送信します。

#### :one::seven: リクエスト :
#### 1️⃣7️⃣ リクエスト :

```console
curl -X GET \
Expand Down Expand Up @@ -1307,7 +1307,7 @@ curl -X GET \
オーナーとスーパー管理者は、削除リクエストを行うことにより、ユーザを組織から削除
することができます。

#### :one::eight: リクエスト :
#### 1️⃣8️⃣ リクエスト :

```console
curl -X DELETE \
Expand Down
36 changes: 18 additions & 18 deletions README.md
Expand Up @@ -371,7 +371,7 @@ Enter a username and password to enter the **Keyrock** application. The default
The following example logs in using the super-admin user - it is the equivalent of using the log-in screen of the GUI.
The URL `https://localhost:3443/v1/auth/tokens` should also work in a secure system.

#### :one: Request:
#### 1️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -421,7 +421,7 @@ above, both variables should be set to `d848eb12-889f-433b-9811-6a4fbf0b86ca` -
with the token `{{X-Auth-token}}` is enquiring about the user holding the token `{{X-Subject-token}}`_ - in this case we
only have one user within the **Keyrock** application, and that user is enquiring about himself.

#### :two: Request:
#### 2️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -460,7 +460,7 @@ Most applications use this endpoint to avoid timing out a user whilst they are i

The `token` value, `d848eb12-889f-433b-9811-6a4fbf0b86ca` was acquired when the user logged on for the first time

#### :three: Request:
#### 3️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -548,7 +548,7 @@ GET, PATCH and DELETE) under the `/v1/users` endpoint.
To create a new user, send a POST request to the `/v1/users` endpoint containing the `username`,`email` and `password`
along with the `X-Auth-token` header from a previously logged in administrative user.

#### :four: Request:
#### 4️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -684,7 +684,7 @@ curl -iX POST \
Making a GET request to a resource under the `/v1/users/{{user-id}}` endpoint will return the user listed under that ID.
The `X-Auth-token` must be supplied in the headers.

#### :five: Request:
#### 5️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -720,7 +720,7 @@ Obtaining a complete list of all users is a super-admin permission requiring the
be permitted to return users within their own organization. Listing users can be done by making a GET request to the
`/v1/users` endpoint

#### :six: Request:
#### 6️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -764,7 +764,7 @@ curl -X GET \
Within the GUI, users can be updated from the settings page. This can also be done from the command-line by making PATCH
request to `/v1/users/<user-id>` endpoint when the user ID is known. The `X-Auth-token` header must also be set.

#### :seven: Request:
#### 7️⃣ Request:

```console
curl -iX PATCH \
Expand Down Expand Up @@ -803,7 +803,7 @@ Within the GUI, users can delete their account from the settings page, selecting
again a super-admin user can do this from the command-line by sending a DELETE request to the `/v1/users/{{user-id}}`
endpoint. The `X-Auth-token` header must also be set.

#### :eight: Request:
#### 8️⃣ Request:

```console
curl -iX DELETE \
Expand Down Expand Up @@ -857,7 +857,7 @@ the `/v1/organizations` endpoint.
To create a new organization, send a POST request to the `/v1/organizations` endpoint containing the `name` and
`description` along with the `X-Auth-token` header from a previously logged in user.

#### :nine: Request:
#### 9️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -894,7 +894,7 @@ Making a GET request to a resource under the `/v1/organizations/{{organization-i
organization listed under that ID. The `X-Auth-token` must be supplied in the headers as only permitted organizations
will be shown.

#### :one::zero: Request:
#### 1️⃣0️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -925,7 +925,7 @@ Obtaining a complete list of all users is a super-admin permission requiring the
be permitted to return users within their own organization. Listing users can be done by making a GET request to the
`/v1/organizations` endpoint

#### :one::one: Request:
#### 1️⃣1️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -970,7 +970,7 @@ The response returns the details of the visible organizations.
To amend the details of an existing organization, a PATCH request is send to the `/v1/organizations/{{organization-id}}`
endpoint.

#### :one::two: Request:
#### 1️⃣2️⃣ Request:

```console
curl -iX PATCH \
Expand Down Expand Up @@ -1002,7 +1002,7 @@ The response contains a list of the fields which have been amended.

### Delete an Organization

#### :one::three: Request:
#### 1️⃣3️⃣ Request:

```console
curl -iX DELETE \
Expand All @@ -1027,7 +1027,7 @@ button:
To add a user as a member of an organization, an owner must make a PUT request as shown, including the
`<organization-id>` and `<user-id>` in the URL path and identifying themselves using an `X-Auth-Token` in the header.

#### :one::four: Request:
#### 1️⃣4️⃣ Request:

```console
curl -iX PUT \
Expand Down Expand Up @@ -1055,7 +1055,7 @@ The response lists the user's current role within the organization (i.e. `member
An owner can also create new owners by making a PUT request as shown, including the `<organization-id>` and `<user-id>`
in the URL path and identifying themselves using an `X-Auth-Token` in the header.

#### :one::five: Request:
#### 1️⃣5️⃣ Request:

```console
curl -iX PUT \
Expand Down Expand Up @@ -1087,7 +1087,7 @@ To list the users of an organization using the GUI, just click on the existing o
Listing users within an organization is an `owner` or super-admin permission requiring the `X-Auth-token`. Listing users
can be done by making a GET request to the `/v1/organizations/{{organization-id}}/users` endpoint.

#### :one::six: Request:
#### 1️⃣6️⃣ Request:

```console
curl -X GET \
Expand Down Expand Up @@ -1122,7 +1122,7 @@ The response contains the users list.
To find the role of a user within an organization, send a GET request to the
`/v1/organizations/{{organization-id}}/users/{{user-id}}/organization_roles` endpoint.

#### :one::seven: Request:
#### 1️⃣7️⃣ Request:

```console
curl -X GET \
Expand All @@ -1149,7 +1149,7 @@ The response returns the role of the given `<user-id>`

Owners and Super-Admins can remove a user from and organization by making a delete request.

#### :one::eight: Request:
#### 1️⃣8️⃣ Request:

```console
curl -X DELETE \
Expand Down

0 comments on commit 3bf27d8

Please sign in to comment.