パブリック API クライアントの作成、構成、削除

1. Vantage で Configuration をクリックします。
2. Tenant Adminstration ダイアログボックスで Create API Client をクリックします。

2. 各値をコピーするには、それぞれの横にある copy icon をクリックします。 または、Save to File をクリックして、両方の値を含む TXT file をダウンロードします。

重要! Client Secret の値はクライアント作成時に一度だけ表示されます。すぐに保存する必要があります。

3. Close をクリックします。
   Public API Client ページが表示されます。

1. Vantage で Configuration をクリックします。
2. Tenant Adminstration ダイアログ ボックスで、Public API Client をクリックします。
3. Public API Client ページで、New Client ドロップダウン リストをクリックし、Add Client をクリックします。

4. 各値をコピーするには、それぞれの横にある copy icon をクリックします。 または、Save to File をクリックして、両方の値を含む TXT file をダウンロードします。

重要! Client Secret の値はクライアント作成時に 1 回だけ表示されるため、すぐに保存する必要があります。

5. Close をクリックします。
   Public API Client ページが表示されます。

1. Client Name フィールドに、新しいパブリック API クライアントの名前を入力します。

2. 新しいシークレットを作成するには、Add Secret をクリックします。既定では、シークレットは 6 か月間有効な状態で作成されます。有効期限は変更でき、最長 36 か月まで設定できます。
3. 新しいリダイレクト URL を追加するには、Add Redirect URL をクリックします。
4. OAuth 2.0 Flows Settings セクションで、許可する認証フローを構成します。
   Note: 外部 ID プロバイダーが構成されている場合、このフローは使用できません。
   1 つ以上のフローを選択できます:
   • Allow Authorization Code Flow。このセキュアな認証スキームを使用した認証を許可します。このスキームでは、認証要求をユーザーへルーティングする代わりに、アプリケーションが直接 Vantage の認可サーバーに送信します。認可サーバーはユーザーの資格情報を検証し、クライアントに認可コードを提供します。Authorization Code Flow はすべての Vantage API クライアントで有効になっています。必要に応じて、次を実行します。
     • Require PKCE for Authorization Code Flow オプションを選択します。このオプションにより、パブリック クライアントの認可時のセキュリティが強化されます。これにより、アクセストークンを要求しているアプリケーションが、認証を開始したアプリケーションと同一であることを Vantage が検証できます。
   • Allow Resource Owner Password Credentials Flow。ユーザー名とパスワードを使用したユーザー認証を許可します。これは、アプリケーションがユーザーのパスワードにアクセスできることを意味し、ユーザーとアプリケーションとの間に高い信頼レベルが必要となります。
   • Allow issuing refresh tokens to refresh access tokens を選択します。このオプションにより、アクセストークンの更新に使用するリフレッシュトークンを発行できるようになります。アプリケーションは、ユーザーとの対話なしに、リフレッシュトークンを使用して新しいアクセストークンを要求できます。ユーザーが認証された状態を維持できるため、アプリケーションはリフレッシュトークンを安全に保管する必要があります。
5. Allow client credentials flow。OAuth 2.0 Client Credentials フローを使用してアプリケーションを認可し、Vantage API へのアクセスを許可します。アプリケーションに割り当てられるロールは、Allow client credentials flow の下にある Manage Roles 設定で決定されます。指定されたロールを使用して、アプリケーションは Vantage にサインインします。
6. Token Lifetime Settings を構成します:
   • Access Token. 発行されたアクセストークンが、ユーザーによる Vantage へのアクセスを許可する期間を定義します。アクセストークンの既定の有効期間は 24 時間です。
   • Refresh Token. 最初のアクセストークンが発行された時点からの固定の期間を定義し、その期間中は発行済みのリフレッシュトークンを使用してアクセストークンを更新できます。リフレッシュトークンの既定の有効期間は 30 日です。