Soracom

Users

ドキュメント
Home ドキュメント SORACOM Krypton Getting Started

SORACOM Krypton を有効化する

Krypton を利用するには、グループ で Krypton を有効化し、そのグループに IoT SIM や Sigfox デバイスなどを所属させます。また、必要に応じて、Amazon Cognito や AWS IoT の設定を追加します。

Krypton の設定はグループに対して行います

ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。

  1. SIM グループ画面で [SORACOM Krypton 設定] をクリックします。

    SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

  2. スイッチをクリックして「ON」にします。

  3. 必要に応じて [+設定を追加する] をクリックして、以下の項目を設定します。

    項目説明
    Amazon CognitoAmazon Cognito から AWS サービスを利用するための期限付き認証情報を取得する場合に追加します。詳しくは、Cognito のクレデンシャルを取得し S3 からファイルをダウンロードする を参照してください。
    AWS IoTAWS IoT のデバイス (モノ) を自動的にプロビジョニングする場合に追加します。詳しくは、AWS IoT の証明書を発行しデバイス登録する を参照してください。
  4. [保存] をクリックします。

  5. IoT SIM が所属するグループを切り替えます。

    Krypton の設定が完了しました。

Krypton を無効化する

グループの設定を変更して、Krypton を無効化します。

  • Krypton を有効化したグループに IoT SIM が所属しているだけでは、プロビジョニング費用 (初期費用、月額料金ともに) は発生しません。詳しくは、SORACOM Krypton のご利用料金 を参照してください。
  • Krypton を有効化したグループから IoT SIM の所属を解除しても、IoT SIM に対する Krypton を無効化できます。詳しくは、グループ設定を解除 (離脱) する を参照してください。
  1. SIM グループ画面で [SORACOM Krypton 設定] をクリックします。

    SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

  2. スイッチをクリックして「OFF」にします。

  3. [保存] をクリックします。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、Krypton を有効化できます。

  • SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールする を参照してください。
  • ${group_id} は、soracom groups list (Group:listGroups API) で取得できます。
  • ${namespace} は、SoracomKrypton です。
  • ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。

Krypton を有効化する

soracom groups put-config (Group:putConfigurationParameters API) を使用します。

$ soracom groups put-config --group-id ${group_id} --namespace SoracomKrypton \
--body '[
  {
    "key": "enabled",
    "value": true
  }
]'
  • SORACOM API を利用するには、API キーと API トークンが必要です。詳しくは、API キーと API トークンの取り扱いについて を参照してください。
  • ${group_id} は、Group:listGroups API で取得できます。
  • ${namespace} は、SoracomKrypton です。
  • ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。

Krypton を有効化する

Group:putConfigurationParameters API を使用します。

$ curl -v -X PUT https://api.soracom.io/v1/groups/${group_id}/configuration/SoracomKrypton \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "key": "enabled",
    "value": false
  }
]'

ボディで指定するプロパティについて

以下の keyvalue のペアを配列で指定します。

keyvalue の型value
enabledBoolean

Krypton の ON/OFF を設定します。

  • true: ON
  • false: OFF

想定していない値を指定した場合の動作は、定義されていません。SORACOM CLI / SORACOM API で設定を変更したあとで、SORACOM ユーザーコンソールで意図通りに設定されていることを確認してください。