コンテンツにスキップ

Device KVSの更新

ネームスペースにあるDevice KVSの情報を更新します。

※ネームスペースは、APIキーのネームスペースになります。

Device KVSのKeyは、ネームスペース内で一意になります。

Valueの書式はJSONです。末尾のカンマ、単一引用符(')はエラーになります。

セキュリティ対策

Valueに重要な情報、個人情報などを登録する場合は、事前に暗号化してから登録してください。

APIキーに必要な権限

DKVS : UPDATE

メソッド

PUT

URL

/v1/dkvs/:key

URLパラメータ

Content-Type: application/json
パラメータ名 必須 内容
:key 文字列 処理対象のKVSのKey。
device_type 数値 デバイスの種類。
0: YubiKey
1: OATH
2: FIDO
3: NJS ATKey
device_id 文字列 デバイスのID。
key 文字列 KVSのKey。
value 文字列 KVSのValue(JSON形式)。

リクエスト例

curl \
  -X PUT \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"key":"key5678", "value":"{\"type\":\"car\",\"color\":\"black\"}}' \
  "https://api.d-auth.com/v1/dkvs/key1234"
  • <API-KEY> : 使用するAPIキー

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1 200 OK 
Content-Type:application/json;charset=utf-8 

レスポンスボディ

{
    "key": "key5678",
    "device_type": 0,
    "device_id": "xxxxxxxxxxxx",
    "value": {
        "type": "car",
        "color": "black"
    },
    "created_at": "2020-10-30 10:10:00"
} 

エラーレスポンス

詳細はこちらをご参照ください。