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

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 プロバイダー (OAuth 2.0 外部 ID プロバイダーの構成 または SAML 2.0 外部 ID プロバイダーの構成 を参照) を準備し、テストしたら、それを Vantage テナントに接続します。
この設定には テナント管理者 ロールが必要です。
外部 ID プロバイダーを有効にすると、このテナントでは Resource Owner Password Credentials 認証フローは使用できなくなります。

​
外部 ID プロバイダーをテナントに接続する

1

ID プロバイダーの設定を開く

Vantage で、左側のペインの Configuration をクリックし、次に Identity Provider をクリックします。
2

外部 ID プロバイダーに切り替える

上部のドロップダウンで External Identity Provider を選択します。
3

プロトコルを選択する

Protocol field で、OAuth 2.0 または SAML 2.0 を選択します。設定パネルがプロトコル固有の fields に更新されます。各 field の詳細については、OAuth 2.0 fields または SAML 2.0 fields を参照してください。
4

プロトコル固有の fields に入力する

事前に用意した provider の値を入力します。
外部 ID プロバイダーの設定 — Azure AD を使用した OAuth 2.0
5

（任意）関連付けられたメールドメインを追加する

Associated Email Domains で + Add Domain URL をクリックし、Domain URL field にドメイン (たとえば example.com) を入力して、Apply をクリックします。さらに追加する場合は、この操作を繰り返します。詳細については、関連付けられたメールドメイン を参照してください。
6

設定を適用する

Apply Changes をクリックします。
Vantage ID プロバイダーに戻す。 元に戻すには、上部のドロップダウンで Vantage を選択し、Apply Changes をクリックします。現在のセッション (アクセストークン) の有効期限が切れていなければ、この操作を実行できます。期限が切れている場合は、アクセスを回復するために、設定済みの外部 ID プロバイダー経由でサインインする必要があります。ロックアウトされた場合は、システム管理者に連絡してください。

​
OAuth 2.0 フィールド

フィールド説明
ID プロバイダープロバイダーの種類です。Active Directory Federation Services (AD FS)、Azure Active Directory (Azure AD)、または OAuth 2.0 に対応するその他の任意のプロバイダーの場合は Other を選択します。
ID プロバイダー URLID プロバイダーの URL です。Azure では、登録済みアプリケーションの Endpoints セクションで確認できます。
Client IDID プロバイダーに登録したアプリケーションのクライアント ID です。
Client Secret (ID プロバイダー が Other に設定されている場合にのみ表示されます。) 登録済みアプリケーションのクライアントシークレットです。
関連付けられたメールドメインまだ Vantage アカウントを持っていない場合でも、このテナントにサインインできるユーザーのメールドメインです。詳しくは、関連付けられたメールドメイン を参照してください。

​
SAML 2.0 フィールド

FieldDescription
Federation Metadata Document URLID プロバイダーの SAML 2.0 フェデレーション メタデータ ドキュメントの URL。
Application ID URI(任意。) ID プロバイダーに対して Vantage アプリケーションを識別するカスタム URI (例: api://<appId>) 。空欄のままにすると、廃止予定の既定値 api://platform.abbyy.cloud/{tenantId} が使用されます。ここで、tenantId はハイフンなしの GUID 形式の Vantage テナント識別子です (例: 117489fc1aea41658369d4d18d6557ga) 。
Associated Email Domainsまだ Vantage アカウントを持っていなくても、このテナントにサインインできるユーザーの関連付けられたメールドメインです。詳細は、関連付けられたメールドメインを参照してください。

​
新規ユーザーのデフォルトロールを設定する

ユーザーが外部 ID プロバイダー経由で自動的に作成されると、Vantage はここで設定したデフォルトロールをそのユーザーに割り当てます。
1

Identity Provider の設定を開く

Vantage で、左側のペインにある Configuration をクリックし、次に Identity Provider をクリックして、上部のドロップダウンから External Identity Provider を選択します。
2

デフォルトロールを選択する

Default Roles For New Users フィールドで、新規ユーザーに自動的に割り当てるロールを 1 つ以上選択します。
3

設定を適用する

Apply Changes をクリックします。
選択した各ロールでは、Allow all current and further skills トグルがデフォルトでオンになっているため、新規ユーザーはテナント内のすべての Skill にアクセスできます。この設定は後から Users ページでユーザーごとに調整できます。各ロールの詳細については、ロールベースアクセス制御 (RBAC) を参照してください。

​
XML ファイルの URL を使用しない SAML 2.0 外部 ID プロバイダーの構成

XML メタデータファイルの内容を Vantage API リクエストにコピーすることで、Vantage を SAML 2.0 の外部 ID プロバイダーを使用するように構成できます。XML ファイルの内容には、SAML 対応の ID プロバイダー と連携するために必要な情報が含まれている必要があります。 Vantage API を使用して SAML 2.0 外部 ID プロバイダーを構成するには、次の手順を実行します。
  1. Vantage API で認証します (詳細は Authentication ドキュメントを参照) 。
  2. https://<your-vantage-url>/api/adminapi2/v1/tenants/<tenantId>/external-providers/ に、ヘッダー Authorization = Bearer <access token> を付与した PUT リクエストを送信し、以下のリクエスト本文パラメーターを含めます。
ParameterDescription
kind使用するプロトコル。値は Saml2 です。
settings.MetadataXML メタデータファイルの内容。
サンプルリクエスト: 
curl --location --request PUT "https://<your-vantage-url>/api/adminapi2/v1/tenants/<tenantId>/external-providers/"
-H "Authorization: Bearer <token>"
{
  "providerSettings": {
    "kind": "Saml2",
    "settings": {
      "Metadata": "<SAML XML file contents>"
    }
  }
}

curl --location --request PUT 'https://<your-vantage-url>/api/adminapi2/v1/tenants/<tenant-id>/external-providers/'
-H 'Authorization: Bearer <token>'
{
  'providerSettings': {
    'kind': 'Saml2',
    'settings': {
      'Metadata': '<SAML XML file contents>'
    }
  }
}

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

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

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

OAuth 2.0 を使用する AD FS または Azure AD

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

SAML 2.0 を使用する AD FS または Azure AD

外部認証のテスト

ユーザーがサインインする前に外部 ID プロバイダーを検証

関連付けられたメールドメイン

特定のメールドメインのユーザーにサインインを許可