OATHの更新¶

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

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

APIキーに必要な権限¶

OATH : UPDATE

メソッド¶

PUT

URL¶

/v1/oath/:device_id

URLパラメータ¶

Content-Type: application/json

パラメータ名	必須	型	内容
:device_id	●	文字列	OATHのデバイスID。
name		文字列	Google Authenticatorsに表示される名前。
service	●	文字列	このデバイスが紐付けられているサービス名。
is_enabled		真偽値	有効かどうか。デフォルトは有効。

リクエスト例¶

curl \
  -X PUT \
  -H "X-DAUTH-API-KEY: <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"is_enabled":false, "service": "example.com"}' \
  "https://api.d-auth.com/v1/oath/xxxxxxxxxxxx"

<API-KEY> : 使用するAPIキー

レスポンス例¶

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

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

レスポンスボディ¶

{
    "device_id": "xxxxxxxxxxxx",
    "name": "jiro",
    "service": "example.com",
    "is_enabled": true,
    "created_at": "2020-10-30 10:10:00"
}

device_id : OATHのデバイスID

注意

タイムゾーンはAPIキーのタイムゾーンが適用されます。

エラーレスポンス¶

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