メインコンテンツへスキップ
テナントで使用する External Identity Provider を設定する前に、指定した External Identity Provider のパラメーターが正しいかを確認します。 Vantage API で外部認証をテストするには、使用するプロトコルに応じて次の手順を実行します。
  1. 使用するプロトコルに応じて、下表で説明するパラメーターを付与して、次のリンクを開きます。
    • OAuth 2.0: https://<your-vantage-url>/api/v1/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>
    • SAML 2.0: https://<your-vantage-url>/api/v1/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>&tenantId=<tenantId>

パラメーター

ParameterProtocolDescription
settingsOAuth 2.0外部 ID プロバイダーの認証設定(JSON 形式)。外部 ID プロバイダーの種類(Kind Parameter。AzureActiveDirectoryOidc または OnPremiseActiveDirectoryOidc を指定)、外部 ID プロバイダーの URL(Authority Parameter)、クライアント ID(ClientId Parameter)を含みます。

例:
{"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3","ClientId":"4e674698-09b8-4ac5-8df7-35d6f0c1e36c"}}
settingsSAML 2.0外部 ID プロバイダーの認証設定(JSON 形式)。外部 ID プロバイダーの種類と外部 ID プロバイダーの URL を含みます。

例:
{"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3/federationmetadata/2007-06/federationmetadata.xml"}}
returnUrlOAuth 2.0 or SAML 2.0認証完了後に遷移する URL。テスト目的の場合は、/skills など任意の Vantage エンドポイントを指定します。URL ルートは、認可に使用されるリンクに自動的に組み込まれます。
tenantIdSAML 2.0SAML 2.0 の外部 ID プロバイダー経由での認証に使用するテナント識別子。
https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3","ClientId":"4e674698-09b8-4ac5-8df7-35d6f0c1e36c"}}&returnUrl=/skills
https://vantage-eu.abbyy.com/auth2/api/v1/account/external/test-challenge?settings={"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/fb46032a-31c4-42ff-890d-6e08d6f57da3/federationmetadata/2007-06/federationmetadata.xml"}}&returnUrl=/skills&tenantId=your_vantage_tenant_id
  1. 外部アイデンティティプロバイダーの認証情報を入力します。
  2. 認証が正常に完了すると、リクエストを送信したページ、または returnUrl で指定されたページにリダイレクトされます。後者の場合、ページのアドレスバーには認証済みユーザーの情報(ユーザー名とメールアドレス)が表示されます。入力したパラメータが正しくない場合は、外部アイデンティティプロバイダーのページに認証エラーが表示されます。その場合は、設定を確認し、適切に修正してからもう一度テストを実行してください。