381 lines
9.2 KiB
Markdown
381 lines
9.2 KiB
Markdown
|
# /user
|
||
|
|
|
||
|
|
ユーザーに関するAPIです。
|
||
|
|
|
||
|
|
## /remove/userid@primaryteant
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| 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>
|
||
|
|
|
||
|
|
## /removebyid/{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>
|
||
|
|
|
||
|
|
## /request/formpost
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| 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>
|
||
|
|
|
||
|
|
## /request/post
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| 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>
|
||
|
|
|
||
|
|
## /request/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>
|
||
|
|
|
||
|
|
## /selfupdate
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| 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>
|
||
|
|
|
||
|
|
## /udetails/{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>
|
||
|
|
|
||
|
|
## /update
|
||
|
|
|
||
|
|
?
|
||
|
|
|
||
|
|
| 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>
|