Soracom

Users

開発者向けツール

API トークンの発行頻度を減らす

soracom subscribers listsoracom subscribers update-speed-class などのコマンドは、実行するたびに API キーおよび API トークンを発行します。1 つのスクリプトで SORACOM CLI のコマンドを複数回実行する場合は、スクリプトの開始時に 1 回だけ soracom auth を実行して API キーおよび API トークンを発行し、それらを再利用してください。

jq コマンドが使える Linux などの環境では、以下のようなスクリプトを用意すると、API キーおよび API トークンを取得し、それらを再利用できます。

# SORACOM CLI に保存した認証キー ID (authKeyId) と 認証キーシークレット (authKey) を取得する
configure_info=$(soracom configure get)
auth_key_id=$(echo ${configure_info} | jq -r '.authKeyId')
auth_key=$(echo ${configure_info} | jq -r '.authKey')

# soracom auth コマンドを実行し、API キーおよび 有効期間 60 秒の API トークンを発行する
auth_info=$(soracom auth --auth-key-id ${auth_key_id} --auth-key ${auth_key} --token-timeout-seconds 60)
api_key=$(echo ${auth_info} | jq -r '.apiKey')
api_token=$(echo ${auth_info} | jq -r '.token')

# 任意のコマンドを実行する
soracom subscribers list --api-key ${api_key} --api-token ${api_token}
API トークンには、有効期間が設定されています。有効期間が経過した場合は、API トークンを再発行してください。
認証キー ID (authKeyId) と 認証キーシークレット (authKey) を SORACOM CLI に保存する
SORACOM CLI に、認証キー ID (authKeyId) と認証キーシークレット (authKey) を保存する操作は、ステップ 2: 認証情報を保存する を参照してください。
SORACOM CLI のコマンドについて
  • soracom configure get について詳しくは プロファイル を参照してください。
  • soracom auth について詳しくは auth を参照してください。
  • soracom subscribers list について詳しくは listSubscribers を参照してください。