機能説明
IDに対応する認証キーの情報を更新します。
リクエスト
エンドポイント
/v1/authorizations/[id]
HTTPメソッド
POSTもしくはPUT
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| name | 文字列 | 0:1 |
|
認証キーを識別するための名前 |
| enable | boolean | 0:1 |
|
認証キーの有効性を設定します。 |
リクエストボディ サンプル
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| リクエストボディがjsonではない | 400 |
| jsonリクエストのバリデーションエラー | 400 |
| クエリパラメータのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| 不正なIDや存在しないID等の理由で削除に失敗した | 403 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
成功
{
"code":200,
"data":{
"head":"b3ph",
"id":1,
"name":"test",
"status":"ENABLE",
"tail":"aQXk"
}
}
失敗
{"code":400,"data_error":{"data":"invalid format"}}
{"code":404,"data_error":{"id":"999 not exists"}}