認証キー登録

APIを利用するための認証キーを登録する。

既に上限数（10個）登録されている場合はエラーとなる。

リクエスト

エンドポイント

/v1/authorizations

HTTPメソッド

POST もしくは PUT

リクエストボディ

JSON形式であること

要素名
型
要素数
制限
説明
name 文字列 0:1

英数字記号日本語問わず256文字まで
入力しない場合は無名として登録

 認証キーを識別するための名前
enable boolean 0:1

true にすることで利用可能になる
デフォルトは false

 認証キーの有効性を設定する
リクエストボディ サンプル

{
  "name":"example",
  "enable": true
}

レスポンス

ステータスコード
状態
コード
成功 200
リクエストボディがjsonではない 400
jsonリクエストのバリデーションエラー 400
認証失敗 401
登録上限数制限などで登録に失敗した 403
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504

レスポンスボディ

成功

{
  "code":200,
  "data":{
    "head":"b3ph",
    "id":1,
    "name":"test",
    "status":"ENABLE",
    "tail":"aQXk",
    "token":"b3pha2l0xxxxxxxxxxFzRGhJxxxxxxJ4SWxYSFF0xxxxxxxxxxh2ZUdaQXk"
  }
}

失敗

{"code":400,"data_error":{"data":"invalid format"}}

{"code":403,"data_error":{"data":"too many"}}