ADManager Plus ナレッジベース

ADManager PlusのAPI連携機能


本ナレッジでは、ADManager PlusのAPI連携機能について説明します。

目次

API連携機能の概要

ADManager Plusでは、APIを利用してServiceDesk Plusや外部アプリケーションと連携することで、外部アプリケーションからADManager Plusの一部機能を利用できます。

API機能のライセンス

ADManager PlusでAPI連携機能を使用するには、オペレーターライセンスが必要です。

1オペレーターライセンスにつき「50」APIコール分のクレジットが自動的に付与されます。
例:3オペレーターライセンスの場合は、合計150クレジットが付与されます。

  • デフォルト管理者アカウント(admin)には、APIコールのクレジットは付与されません。
  • 消費したAPIコールのクレジットは、消費してから24時間後にリセットされ、再度使用可能になります。
  • 各オペレーターにはコール数の制限はなく、合計クレジット数の範囲でAPIコールを実行できます。
  • APIコールのクレジットは、APIコールの実行が成功した場合にのみ消費されます。
    また、当該クレジットは実際に成功した変更数に応じて消費されるため、例えば1度に10人のユーザーアカウントを変更した場合は、10クレジットが消費されます。

ADManager Plusのオペレーター(委任機能)の詳細につきましては、こちらのナレッジをご参照ください。

外部アプリケーションとの連携方法

ADManager Plusと連携可能な外部アプリケーションの連携手順につきましては、こちらのページより連携するアプリケーションのドキュメントをご参照ください。

認証トークンの生成手順

API連携機能を使用するには、オペレーターの認証トークンが必要となる場合があります。

認証トークンは以下の手順で生成できます。

手順
  1. ADManager Plusに管理者としてログインします。
  2. [委任]タブ→[設定]→[オペレーター用のAuthtoken]を開きます。
  3. [+ 認証トークンを生成する]をクリックします。
  4. 以下の項目をそれぞれ設定し、[認証トークンを生成する]をクリックします。
    • オペレーターの選択:認証トークンを生成するオペレーターを選択します。
    • 認証トークン名:任意の名称を入力します。
    • スコープ:生成する認証トークンを利用して実行できる操作権限を選択します。
    • 期限切れ時間:認証トークンの有効期間を指定します。

  5. 表示された認証トークンをメモします。