REST API認証
LifeTime Deployment APIのRESTメソッドを呼び出すには、サービスアカウントと呼ばれる特殊なタイプのアカウントが必要です。
サービスアカウントはLifeTimeで作成される特殊なアカウントで、OutSystemsとのPC間のやりとりで使用されます。サービスアカウントは、ロールとチームを使用してアクセス権限を定義する通常のユーザーアカウントと同じ権限モデルに従います。
サービスアカウントを作成すると、LifeTimeで認証トークン文字列が生成され、これをすべてのREST APIリクエストに含める必要があります。各認証トークンには特定のサービスアカウントの認証に必要なすべての情報が含まれています。
セキュリティに関する考慮事項
REST APIメソッドの呼び出しはすべて監査され、リクエストの認証トークンによってサービスアカウントまで遡ることができます。LifeTimeのサービスアカウントのアクティビティログでログを参照できます。
OutSystems REST APIを使用する場合は、以下のセキュリティに関する事項を考慮してください。
- 認証トークンはプラットフォームに保存されないため、コンシューマは認証トークンを安全に保存する必要があります。サードパーティが認証トークンにアクセスできた場合、インフラへのアクセスが可能になります。
- APIコンシューマとAPIサーバーの間のすべての通信はHTTPS経由で行う必要があります。
以下のセクションでは、サービスアカウントを管理する方法とREST API呼び出しの認証を行う方法について説明しています。
サービスアカウントを作成する
LifeTimeでサービスアカウントを作成するには、以下の手順を実行します。
-
インフラのLifeTime管理コンソールで、［User Management］タブを開いて［Service Accounts］サブメニューを選択します。
-
［New Service Account］を選択します。サービスアカウントのユーザー名と説明を入力し、希望するロールを選択して、［Create］ボタンをクリックします。
サービスアカウントを作成すると、リクエストの認証のために各REST APIメソッドの呼び出しに含める必要がある認証トークンが表示されます。
セキュリティ対策のため、認証トークンが表示されるのは1回のみです。トークンを失った場合は新しいトークンを生成する必要があり、前のトークンは無効になります。
REST API呼び出しを認証する
各REST APIメソッドの呼び出しの認証を行うには、アクティブなサービスアカウントの認証トークンを提供する必要があります。トークンは、REST APIリクエストの追加のHTTPヘッダーとして次の形式で含める必要があります:
Authorization: Bearer <認証トークン>
認証トークンを取り消す
特定の認証トークンを取り消したり非推奨にしたりする必要がある場合は、 以下の手順に従って、対応するサービスアカウントの新しいトークンを生成します。
-
［User Management］タブに移動し、［Service Accounts］サブメニューを選択します。
-
トークンを取り消し/非推奨にするサービスアカウントに対応するリンクをクリックします。
-
［Generate new Authentication Token］リンクをクリックします。
-
［Continue］をクリックして、新しいトークンを生成することを確認し、前のトークンが取り消し/非推奨になり使用できなくなることをよく理解します。
現在のサービスアカウントの新しいトークンが生成、表示されます。生成されたトークンは再表示されないため、トークンをメモに取ります。