569 lines
14 KiB
Markdown
569 lines
14 KiB
Markdown
|
# /usergroup
|
||
|
|
|
||
|
|
ユーザーグループに関するAPIです。
|
||
|
|
|
||
|
|
## /add
|
||
|
|
|
||
|
|
ユーザーグループにメンバーを追加する。
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /adminlist
|
||
|
|
|
||
|
|
get list of groups for admins
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /delete/{id}
|
||
|
|
|
||
|
|
delete a group
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /details/{id}
|
||
|
|
|
||
|
|
get details and members of group
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /list/{id}
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /members/{id}
|
||
|
|
|
||
|
|
グループのメンバーを取得する。
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /members/email/{id}
|
||
|
|
|
||
|
|
グループに所属するユーザーのメールアドレスを取得する。
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /members/multi
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: gray; ">?</span> Fetch resource | データの取得 |
|
||
|
|
| `POST` | <span style="color: gray; ">?</span> Create resource | データの送信 (主に新規作成) |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /mylist
|
||
|
|
|
||
|
|
get my group list.
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /openlist
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /remove/{id}
|
||
|
|
|
||
|
|
removes members. should be empty before delete
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
## /update
|
||
|
|
|
||
|
|
add orupdate group details other than members
|
||
|
|
|
||
|
|
| HTTP Method | Description | |
|
||
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||
|
|
|
||
|
|
:arrow_forward: ^^リクエスト^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルリクエストデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
TBD
|
||
|
|
```
|
||
|
|
|
||
|
|
:arrow_backward: ^^レスポンス^^
|
||
|
|
|
||
|
|
パラメータ
|
||
|
|
|
||
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
||
|
|
| ---- | --- | --- | --- | --- |
|
||
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||
|
|
|
||
|
|
サンプルレスポンスデータ
|
||
|
|
|
||
|
|
``` JSON title="JSON"
|
||
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! 補足
|
||
|
|
|
||
|
|
* 最終更新日： 2025/xx/xx
|
||
|
|
|
||
|
|
??? フリーメモ
|
||
|
|
|
||
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
||
|
|
* 自由なメモを記載できます
|
||
|
|
|
||
|
|
<br>
|