機能説明
アカウントIDのみを指定して、管理画面におけるユーザーごとの操作履歴一覧を取得します。
開始番号と終了番号の指定は任意です。指定がなければデフォルト値が指定されます。
開始番号は1以上、終了番号は開始番号以上の数値を指定することができます。
一度に取得可能な操作履歴数は、1000件までです。
リクエスト
エンドポイント
/v1/audits/[id]?from=[開始番号]&to=[終了番号]
HTTPメソッド
GET
リクエストボディ
なし
リクエストパラメータ
|
パラメータ名
|
説明
|
|---|---|
| id | アカウントID |
クエリパラメータ
|
クエリ名
|
デフォルト値 |
説明
|
|---|---|---|
| from | 1 | 指定は任意 |
| to | 取得可能な最大値 | 指定は任意 |
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| バリデーションエラー | 400 |
| 認証失敗 | 401 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| data | 操作履歴型の配列 | 0:* | - |
操作履歴
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| account_id | 数値 | 1 | アカウントID |
| event_type | 文字列 | 1 | イベント名 |
| succeeded | 真偽値 | 1 |
イベントの成否
|
| ip_address | 文字列 | 1 | イベント発生時の接続IPアドレス |
| created | 文字列 | 1 | イベント発生日時 |
| account_name | 文字列 | 1 | アカウント名 |
成功
{
"code": 200,
"data": [
{"account_id":1,"event_type":"login","succeeded":true,"ip_address":"192.168.111.111","created":"2021-01-01 12:12:12","account_name":"test"},
{"account_id":1,"event_type":"login","succeeded":true,"ip_address":"192.168.111.111","created":"2021-01-01 22:22:22","account_name":"test"},
]
}
失敗
{"code":400,"validation_errors":{"from":"must be 1 or more. current 0","to":"must be 1 or more. current 0"}}