公開 API クライアントを作成または管理できるのは、Tenant Administrator のみです。
公開 API クライアントの作成
1
Configuration を開く
Vantage で、左ペインの Configuration をクリックします。
2
クライアントの作成を開始する
Tenant Administration ダイアログで、次のいずれかを行います。
- このテナントで最初のクライアントの場合: Create API Client をクリックします。
- 2 つ目以降のクライアントの場合: 公開 API クライアント をクリックし、公開 API クライアント ページで New Client ドロップダウンリストを開いて Add Client をクリックします。
3
Client ID と Client Secret をコピーする
Client Created ダイアログで、各値の copy アイコンをクリックしてコピーします。または、Save to File をクリックして、両方の値が含まれる TXT ファイルをダウンロードします。
4
ダイアログを閉じる
Close をクリックします。公開 API クライアント ページが開き、新しいクライアントを設定できます。
公開 API クライアント の設定
1
クライアントに名前を付ける
Client Name field に、このクライアントを識別する名前を入力します。
2
シークレットを管理する
Add Secret をクリックして、新しいクライアント シークレットを作成します。既定では、新しいシークレットの有効期限は 6 か月です。有効期限は 1 日から 36 か月まで設定できます。
3
リダイレクト URL を追加する
Add Redirect URL をクリックし、認可のリダイレクト先として許可する各 URL を入力します。
4
OAuth 2.0 フローを設定する
OAuth 2.0 Flows Settings セクションで、クライアントが使用できるフローを 1 つ以上選択します。
- Allow Authorization Code Flow — アプリケーションが認証リクエストを Vantage の認可サーバーに直接送信する、安全な認証方式です。サーバーは資格情報を検証し、認可コードを返します。このフローは、すべての Vantage API クライアントで有効になっています。
- Require PKCE for Authorization Code Flow — アクセス トークンを要求するアプリケーションが、認証を開始したアプリケーションと同一であることを Vantage が検証できるようにすることで、パブリック クライアントのセキュリティを強化します。
- Allow Resource Owner Password Credentials Flow — ユーザー名とパスワードを使用したユーザー認証を可能にします。アプリケーションはユーザーのパスワードに直接アクセスできるため、ユーザーが完全に信頼しているアプリケーションでのみ使用してください。
- Allow issuing refresh tokens to refresh access tokens — ユーザーに再度入力を求めることなくアクセス トークンを更新できるように、クライアントがリフレッシュ トークンを発行できるようにします。アプリケーションはリフレッシュ トークンを安全に保存する必要があります。
- Allow client credentials flow — OAuth 2.0 Client Credentials flow を通じて、アプリケーションに Vantage API へのアクセスを許可します。ロールは、このオプションの下にある Manage Roles 設定によって決まります。
External Identity Provider が設定されている場合、Resource Owner Password Credentials flow は使用できません。Authentication を参照してください。
5
トークンの有効期間を設定する
Token Lifetime Settings セクションで、次を設定します。
- Access Token — 発行されたアクセス トークンで Vantage へのアクセスが許可される期間。既定値: 24 時間。
- Refresh Token — 最初のアクセス トークンの発行時点から始まる絶対期間。この期間中、リフレッシュ トークンを使用してアクセス トークンを更新できます。既定値: 30 日。
公開 API クライアントの削除
