メインコンテンツへスキップ左側ペインのConfigurationタブで Vantage API クライアントを作成および設定できます。
API クライアントを作成するには、次の手順に従います。
- Create API Client をクリックします。
- 開いたダイアログに、作成したクライアントの Client ID と Client Secret が表示されます。各値の横にあるアイコンをクリックして値を保存できます。あるいは、Save to File ボタンをクリックして、Client ID と Client Secret の値を含む TXT ファイルの保存先を指定できます。
重要 クライアント作成時のみ Secret の値が表示されます。直ちに保存してください。
- Close をクリックします。
上記の手順後、自動的に作成したクライアントの編集ページに移動します。ここで以下を実行できます。
- Client Name フィールドでクライアント名を変更します。
- Add Secret をクリックして新しい Secret を作成します。既定では Secret の有効期間は 6 か月です。
- Add Redirect URL をクリックして新しいリダイレクト URL を追加します。
- OAuth 2.0 Flows Settings セクションで許可する認証フローを構成します。複数選択できます。
- Allow Authorization Code Flow。この安全な方式での認証を許可します。ユーザーに認証要求を回すのではなく、アプリケーションが Vantage の認可サーバーに直接送信します。認可サーバーはユーザーの資格情報を検証し、クライアントに認可コードを付与します。Authorization Code Flow はすべての Vantage API クライアントで有効です。必要に応じて以下を選択します。
- Require PKCE for Authorization Code Flow。パブリッククライアントの認可時のセキュリティを強化します。アクセス トークンを要求するアプリケーションが、認証を開始したアプリケーションと同一であることを Vantage が検証できるようにします。
- Allow issuing refresh tokens to refresh access tokens。更新用のリフレッシュ トークンの発行を許可します。アプリケーションはユーザーと対話せずに、リフレッシュ トークンを使って新しいアクセス トークンを要求できます。リフレッシュ トークンはユーザーを認証済みの状態に保てるため、安全に保管する必要があります。
- Allow Resource Owner Password Credentials Flow。ユーザー名とパスワードでのユーザー認証を許可します。アプリケーションがユーザーのパスワードにアクセスできるため、ユーザーとアプリケーション間に高い信頼が求められます。
注: 外部 ID プロバイダーが構成されている場合、このフローは使用できません。
- Allow client credentials flow。OAuth 2.0 の Client Credentials フローでアプリケーションを認可し、Vantage API へのアクセスを付与します。アプリケーションに割り当てられるロールは、Allow client credentials flow の下にある Manage Roles 設定で決まります。指定したロールでアプリケーションは Vantage にサインインします。
認証フローの詳細については、Authentication を参照してください。
新しいクライアントを作成する場合は、New Client ドロップダウン リストで Add Client を選択します。このリストには既存のクライアントもすべて表示され、クリックするとそのクライアントの編集ページが開きます。必要に応じて、クライアント名やロールで検索できます。
クライアントを削除するには、アイコンをクリックしてから Delete Client をクリックします。
