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

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.

システム管理者は、テナント管理者に Fulfillment Operator ロールを割り当てることができます。このロールが付与されると、テナント管理者は Vantage API を通じて新しいテナントを作成でき、また自分のテナント内の他のユーザーにこのロールを付与することもできます。 Vantage API でテナントを作成するには、Fulfillment Operator は次を実行します。
  1. Vantage API で認証します。詳細は Authentication を参照してください。
  2. ヘッダーに Authorization = Bearer <access token> を設定し、以下のリクエストボディ パラメーターを含めて {baseUrl}/api/publicapi/v1/invites/ に POST リクエストを送信します。
ParameterDescription
Model次のパラメーターを含むオブジェクト：useMySubscription、email、tenantName、validWithin、tenantDescription。
email新たに作成されるテナント管理者のメールアドレス。
validWithin招待の送信時点から、招待を受け入れられる有効期間。形式は days.hours:minutes:seconds です。既定値は 14.00:00:00 (14 日) です。
tenantNameテナント名。テナント名は一意でなければなりません。同じ名前のテナントを作成しようとするとエラーになります。
useMySubscription現在のテナントのサブスクリプションを使用するかどうかを指定します。現在のテナントのサブスクリプションを使用する場合、両方のテナント (現在のテナントと新しいテナント) は同じページ使用カウンターを共有します。いずれかのテナントがそのカウンターの残りページを使い切ると、どちらのテナントもそれ以上使用できなくなります。パラメーターの既定値は False であり、新しいサブスクリプション ファイルをダウンロードする必要があることを意味します。
tenantDescriptionテナントの説明。テナントを説明する任意のテキストを指定でき、このテキストはシステム管理者に表示されます。

​
リクエストの例

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'Model={
  "useMySubscription": false,
  "email": "test@test.com",
  "tenantName": "name",
  "validWithin": "14.00:00:00",
  "tenantDescription": "description"
}' \
  --form File='@example-file'

テナント管理

Vantage におけるテナント管理の概要

Vantage API クライアントの管理

新しいテナント用の API クライアントを設定します

Vantage API を使用したクライアントの作成

API クライアントをプログラムで作成します