外部認証をテスト - ABBYY Documentation

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

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

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

使用するプロトコルに対応する URL 形式を使用し、以下の Parameters リファレンスを参照してパラメーターを指定します。完全な例については、Sample links を参照してください。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>

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

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

結果を確認する

次の 3 つのいずれかになります。

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

パラメーター

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

OAuth 2.0 の `settings`

Field	説明
`Kind`	`AzureActiveDirectoryOidc` または `OnPremiseActiveDirectoryOidc`
`Settings.Authority`	外部 ID プロバイダーの URL
`Settings.ClientId`	ID プロバイダーのクライアント 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	説明
`Kind`	`Saml2`
`Settings.MetadataUri`	フェデレーションメタデータドキュメントの URL
`Settings.OwnEntityId`	`api://<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"
  }
}

サンプルリンク

サンプルリンク（OAuth 2.0）

https://vantage-eu.abbyy.com/auth2/api/v1/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

サンプルリンク（SAML 2.0）

https://vantage-eu.abbyy.com/auth2/api/v1/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 の settings

​SAML 2.0 の settings

​サンプル リンク

​関連トピック

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

パラメーター

OAuth 2.0 の `settings`

SAML 2.0 の `settings`

サンプルリンク

関連トピック