SORACOM Developers

Getting Started

SORACOM Access Management を使用して操作権限を管理する

SAM(SORACOM Access Management) をご利用いただくと、SORACOM のコンソールおよび API に対する操作権限を管理することができます。ここでは、ユーザーコンソールを使用して、以下を実施します。

はじめに

SORACOM Access Managament(SAM) は、管理ユーザー毎にアクセス権限を設定できるアクセス管理機能です。アカウント管理者は、利用者の管理を簡単に行うことができるほか、不要なアクセスや操作ミスを未然に防ぐことができます。

大規模な IoT システムを構築する際、様々な役割を持つ管理者やプログラムが想定され、全ての管理者やプログラムにすべてのアクセス権限を付与する必要はありません。このような場合にSAMを利用すると、アカウントに関する全操作ができる管理者「オペレーター」の下に、アクセス権限が限定されたユーザーである「SAMユーザー」を発行し、そのユーザーごとに利用できる API や、利用可能期間などの条件を設定することができます。

SAM ユーザーは、作成しただけでは各種コンソール機能/API にアクセスすることはできません。SAM ユーザーに対して、アクセスを許可するための権限を付与すると各種コンソール機能/API にアクセスできるようになります。

権限は、「パーミッション構文」という形式で SAM ユーザーに直接付与することができます。また、「ロール」と呼ばれる権限設定のためのグループを予め作成して、そのロールを SAM ユーザーに関連付けることでも権限を付与することもできます。

全体像を図にまとめると以下のようになります。

SAMの概要

SAM ユーザーの作成と認証設定

SAM ユーザーの作成

SAM ユーザーの作成は、ユーザーコンソールの左上部のメニューの「セキュリティ」から行います。
画面上の「ユーザー」タブを開き、 [ユーザー作成] ボタンをクリックします。

セキュリティメニュー

SAMユーザーの作成

ダイアログにユーザー名と概要を入力します。ここで入力したユーザー名は、この後のコンソールログインの際に使用します。

SAMユーザーの入力画面

これで SAM ユーザーの作成完了です。

SAM ユーザーの認証設定

次に、SAM ユーザーの認証情報の設定を行います。先ほど作成した SAM ユーザーを、一覧から選択します。

SAMユーザーの選択

この画面で、SAM ユーザーの各種設定を行うことが出来ます。画面内のタブから、[認証設定] を選択します。

認証設定

「認証キー」 とはSAM ユーザーに割り当てられる認証情報で、API 呼び出しに使用します。そしてコンソールログインパスワードは、ユーザーコンソールのログイン時に使用するログインパスワードです。

初期状態ではいずれも設定されていないため、もし SAM ユーザーが API を利用するのであれば認証キーを、コンソールログインをするのであればコンソールログインパスワードを設定します。

コンソールログインパスワードの設定

SAM ユーザーでコンソールにログインするため、コンソールログインパスワードを設定します。

コンソールログインパスワードを設定するのは、[パスワード設定] ボタンをクリックします。

認証キーの生成

パスワードを入力して、設定を行います。

コンソールログインパスワードの設定

設定したパスワードを使用して、コンソールにログインできるようになりました。

認証キーの設定

SAM ユーザーが API を使用する場合は、認証キーの設定を行います。

認証キーを設定する場合は、[認証キーを生成] ボタンをクリックします

認証キーの生成

クリックをすると、「認証キー ID」 と 「認証キーシークレット」 が生成されます。この2つを使って認証 APIを呼び出すと、SAM ユーザーとして SORACOM API を使用することができます。

認証キー

生成されたキーを使用して、API の認証を行うことができるようになりました。なおこの認証キーは再発行されないため、必ず安全な場所に保管するようにしておきましょう。

SAM ユーザーの権限設定

権限の設定

次に、この SAM ユーザーが SORACOM へアクセス出来るように、権限設定を行います。

SAM ユーザーの設定画面より、[権限設定] を選択します。

コンソールログインパスワードの設定

権限の設定には2種類あり、1つが 「直接指定(インライン権限)」 、もう1つが 「ロール(Role)」 と呼ばれる機能を使用する方法です。

直接指定の場合、SAM ユーザーに直接権限設定を行うことができます。ユーザー毎に個別の権限を割り当てる際にはこちらの機能を使うと便利です。また、ロールを使うと、事前に権限を設定したロールを作成しておき、それを SAM ユーザーに関連付けるという形で権限設定を行うことができます。

当ガイドでは直接指定(インライン権限)で設定を行います。

権限は「パーミッション構文」という JSON 形式の構文で記述することにより設定することができます。例えば SIM の一覧のみ表示する権限を持つユーザーを作成する場合、以下の様な構文を設定します。

SIM一覧のみ表示

このようにSAM ユーザーへ柔軟にアクセス権限を設定することが可能です。
パーミッション構文の詳細な利用方法については、パーミッション構文の詳細をご確認ください。

参考:ロール機能の使い方
  • ロールの作成・権限設定は、ユーザーコンソールの [セキュリティ]>[ロール] の画面から行います。
  • 作成済みのロールをユーザーに関連付けるには、ユーザー詳細画面の [ロールをアタッチ] ボタンから設定します。ボタンをクリックすると作成済みのロール一覧が表示されますので、ユーザーに割り当てたいロールにチェックを入れて[アタッチ]ボタンをクリックします。

SAM ユーザーでのコンソールログイン

上記の操作で、コンソールログインが可能な SAM ユーザーの作成が完了しています。

ユーザーコンソールへのログインは、ログイン画面より行います。

ログイン画面の [SAM ユーザーとしてログイン] をクリックします。

SAMユーザーログインへ

ログインに必要な情報は、 「オペレーター ID」 「SAM ユーザー名」 「コンソールログインパスワード」 の3つです。

SAMユーザーログインへ

SAM ユーザー名およびコンソールログインパスワードは、先出の手順内で作成したものを使用します。

オペレーター ID は 「OP」 からはじまる ID で、オペレーターごとに割り振られています。

オペレーター ID がわからない場合は、オペレーターでログイン後、右上のメニューから確認することができます。

SAMユーザーログインへ

Getting Started

SORACOM Air for セルラー

SORACOM Air for LoRaWAN

SORACOM Air for Sigfox

SORACOM Beam

SORACOM Canal/Direct/Door

SORACOM Endorse

SORACOM Funnel

SORACOM Gate

SORACOM Harvest

SORACOM Inventory

SORACOM Junction

サービス機能詳細

Developer Tools

pagetop