APIリファレンス

用語集

APIリファレンス内で使用されている用語とその定義は、以下のとおりです。

用語 定義
DeviceConnectManager スマートフォンやSTB等にインストールし、IoTアクセス制御エンジンとプラグイン、デバイスの連携を行うためのソフトウェア。ゲートウェイのAndroid向け具体的実装のこと。
IoTアクセス制御エンジン 本システム意味する。なお、“Symphony”は本システムの開発コードネームを指す。
アクション サービスと同義で用いられるが、アクションは特にプロファイルによって細分化された機能を指す。
アクセストークン マイユーザがログイン時に払い出されるトークン。ログイン関連を除き全てのAPIの実行にはアクセストークンを付与する必要があり、アクセストークンによってユーザを一意に決定できる。未ログインであっても払いすことは可能であり、その場合はシステムビルトインユーザ（PUBLIC_USER）となり、機能は制限される。
オーナー デバイスの所有者。パーミッションに関するすべての権限を有する。
共有ユーザ ユーザが他ユーザに対してロールを通じてリソースへのパーミッションを付与した状態、付与されたユーザを意味する。
ゲートウェイ プラグイン（およびデバイス）とIoTアクセス制御エンジンを中継する機器やソフトウェアのこと。Android向けDeviceConnectManagerのほか、Node.jsの実装も存在する。
サービス リソースが提供する機能を意味する。
シング（Thing） Symphonyデバイスのことを、特別にシング（Thing）と呼ぶことがある。マイユーザが所有するシングは、ThingIdという一意な識別子（ID）で管理される。
タグ マイユーザが自由に設定できるタグ。1つのタグに対して複数のSymphonyデバイスを紐付けることが可能。Device APIのパラメータに設定して実行することが可能であり、その際にはタグに紐付く全てのSymphonyデバイスに対して当該Device APIが呼び出される。
チーミングデバイス 2つの異なるゲートウェイそれぞれに紐づくSymphonyデバイスを、1つの仮想的なSymphonyデバイスに束ねた状態のことを指す。
デバイス リソースのうち、スマートフォンやSTB等の本体やそれらに接続されたWi-Fi接続機器、BLE接続機器等を意味する。また、特別にSymphonyデバイスと呼称する場合、Management APIによりデバイス登録されているデバイス（Thing）のことを指す。
ニックネーム マイユーザがSymphonyデバイスに付与することができる名称、エイリアス。1つのニックネームに対して複数のSymphonyデバイスを設定可能。ニックネームは、Device APIのパラメータに設定して実行することが可能である。
パーミッション マイユーザが共有ユーザに利用を許可する対象、条件を定義する。
プラグイン プロファイルの具体的実装のこと。デバイス固有の通信方式やAPI、SDKにより実装され、デバイス制御の詳細を担当するソフトウェア。AndroidやLinux上のプラグインだけではなく、クラウド上に配置されることもある。
プロファイル サービスが提供する機能セット。プラグインに実装されているサービスおよびアクションの一般的な機能区分や動作仕様をプロファイルと呼称する。
ポリシー マイユーザが共有ユーザに利用を許可する機能を定義する。デバイスへのアクセス、記録データへのアクセスを指定することが可能である。
マイユーザ ユーザのうち、特別に「マイユーザ」と表現された場合には、ログインを能動的に行った自分自身を意味する。
ユーザ ユーザとは、IoTアクセス制御エンジン登録ユーザあるいはシステムビルトインユーザを意味する。システムビルトインユーザとしてPUBLIC_USERが存在する。また、特別に「マイユーザ」と表現された場合には、ログインを行った自分自身を意味する。
リソース 所有者によって登録されたデバイスそのもの、あるいは、デバイスが所持する各種サービスを意味する。
リフレッシュトークン アクセストークンの有効期限が切れた場合など、アクセストークンを更新する際に用いられるトークン。アクセストークンと同時に払い出されるが、システムビルトインユーザ（PUBLIC_USER）には払い出されない。
ロール ユーザが任意に管理可能な共有ユーザに付与する役割、パーミッションのセットを意味する。
ドキュメント