権限とセキュリティ
権限は、API Keyに許可される操作を定義します。
権限
| 権限 | 種類 | 用途 |
|---|---|---|
device:read | 読み取り専用 | デバイス一覧の取得、デバイス詳細の取得、デバイスタイプ定義一覧の取得、コマンド結果の取得 |
device:control | コマンドの書き込み | device:read のすべての照会権限を含み、リレー・RS485などの操作コマンドをデバイスに送信できる |
device:config | 設定の書き込み | device:read のすべての照会権限を含み、デバイス設定を変更できる |
device:manage | 管理 | device:read のすべての照会権限を含み、デバイスの追加・削除・パスワード変更ができる |
統合に必要な最小限の権限を使用してください。
例:
| 統合の種類 | 推奨される権限 |
|---|---|
| 監視または在庫同期 | device:read |
| デバイス操作の統合 | device:control |
| デバイス設定の統合 | device:config |
| デバイス管理の統合 | device:manage |
| フル制御の統合 | device:control、device:config、device:manage |
アクセス境界
- すべてのエンドポイントは、あなたのアカウントに属するデバイスにのみアクセスできます
device:manageは、REST API経由でのデバイス所有権とパスワード管理(デバイスの追加、削除、パスワード変更)を可能にします- API Keyが有効に認証されているものの必要な権限を持たない場合、REST APIは
403 AUTH_SCOPE_DENIEDを返します - 認証情報が欠落・無効・期限切れの場合、REST APIは
401を返します
