メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

外部 ID プロバイダーをテナントに適用する前に、パラメーターをテストして、Vantage がそのプロバイダー経由で認証できることを確認してください。

外部 ID プロバイダーをテストする

1

ブラウザーで test-challenge URL を開く

使用するプロトコルに対応する URL 形式を使用し、以下の Parameters リファレンスを参照してパラメーターを指定します。完全な例については、Sample links を参照してください。OAuth 2.0:
https://<your-vantage-url>/api/v2/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>
SAML 2.0:
https://<your-vantage-url>/api/v2/external/test-challenge?settings=<settings>&returnUrl=<returnUrl>&tenantId=<tenantId>
2

外部 ID プロバイダーで認証する

ID プロバイダーのサインイン ページで認証情報を入力します。
3

結果を確認する

次の 3 つのいずれかになります。
  • returnUrl がある場合の成功 — Vantage により、returnUrl で指定された URL にリダイレクトされます。アドレス バーには、認証されたユーザーのユーザー名とメール アドレスが表示されます。
  • returnUrl がない場合の成功 — Vantage により、テスト リンクを開いた元のページにリダイレクトされます。
  • 失敗 — ID プロバイダーのサインイン ページに認証エラーが表示されます。パラメーターを確認し、もう一度テストを実行してください。

パラメーター

パラメーター必須対象説明
settingsOAuth 2.0、SAML 2.0外部 ID プロバイダーを記述する JSON。形式はプロトコルによって異なります。詳細は以下を参照してください。
returnUrlOAuth 2.0、SAML 2.0テストが正常に完了した後に Vantage がリダイレクトする先の URL。テストには、/skills などの任意の Vantage エンドポイントを使用します。URL のルート部分は自動的に付加されます。
tenantIdSAML 2.0 のみ認証に使用する Vantage の tenant identifier。

OAuth 2.0 の settings

Field説明
KindAzureActiveDirectoryOidc または OnPremiseActiveDirectoryOidc
Settings.Authority外部 ID プロバイダーの URL
Settings.ClientIdID プロバイダーのクライアント ID
例:
{
  "Kind": "AzureActiveDirectoryOidc",
  "Settings": {
    "Authority": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888",
    "ClientId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
  }
}

SAML 2.0 の settings

field説明
KindSaml2
Settings.MetadataUriフェデレーション メタデータ ドキュメントの URL
Settings.OwnEntityIdapi://<appId> 形式の Application ID URI
例:
{
  "Kind": "Saml2",
  "Settings": {
    "MetadataUri": "https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888/federationmetadata/2007-06/federationmetadata.xml",
    "OwnEntityId": "api://cccc3333-dddd-4444-eeee-5555ffff6666"
  }
}
https://vantage-eu.abbyy.com/auth2/api/v2/account/external/test-challenge?settings={"Kind":"AzureActiveDirectoryOidc","Settings":{"Authority":"https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888","ClientId":"aaaabbbb-0000-cccc-1111-dddd2222eeee"}}&returnUrl=/skills
https://vantage-eu.abbyy.com/auth2/api/v2/account/external/test-challenge?settings={"Kind":"Saml2","Settings":{"MetadataUri":"https://login.microsoftonline.com/11112222-3333-4444-5555-666677778888/federationmetadata/2007-06/federationmetadata.xml","OwnEntityId":"api://cccc3333-dddd-4444-eeee-5555ffff6666"}}&returnUrl=/skills&tenantId=your_vantage_tenant_id

外部 ID プロバイダーの設定

OAuth 2.0 および SAML 2.0 プロバイダーの設定概要

テナントの外部 ID プロバイダーの設定

外部 ID プロバイダーをテナントに適用する

OAuth 2.0 外部 ID プロバイダーの設定

OAuth 2.0 を使用した AD FS または Azure AD

SAML 2.0 外部 ID プロバイダーの設定

SAML 2.0 を使用した AD FS または Azure AD