Citrix Endpoint Management™

REST API

  • Citrix Endpoint Management REST APIを使用すると、次のことが可能になります。

  • Citrix Endpoint Managementコンソールに表示されるサービスを呼び出す
  • 任意のRESTクライアントを使用してRESTサービスを呼び出す

APIは、サービスを呼び出すためにCitrix Endpoint Managementコンソールにサインオンすることを要求しません。

  • 利用可能なAPIの完全な最新セットについては、RESTサービス用パブリックAPI PDFをダウンロードしてください。

  • モバイルおよびデスクトップのエンドポイントデバイスを管理し、Workspaceアプリの設定を構成するためのAPIが利用可能です。https://developer.cloud.com/citrixworkspaceにアクセスし、Citrix Endpoint Management > モバイルアプリケーション統合に移動してください。

REST APIへのアクセスに必要な権限

REST APIへのアクセスには、次のいずれかの権限が必要です。

  • Citrix Cloud管理者
  • ロールベースのアクセス構成の一部として設定されたパブリックAPIアクセス権限。詳細については、RBACによるロールの構成を参照してください。
  • スーパーユーザー権限

Citrix Cloudアカウントを使用してREST APIにアクセスするには、APIキーを生成します。

  1. Citrix Cloudメニューから、[IDおよびアクセス管理]を選択します。
  2. [APIアクセス] > [セキュアクライアント]を選択します。
  3. セキュアクライアントの名前を入力し、[クライアントの作成]をクリックします。

Citrix Cloudは、セキュアクライアントIDとクライアントシークレットを作成します。この情報のコピーをダウンロードし、参照用に安全にオフラインで保存してください。Citrix Cloudは、ダイアログボックスを閉じると一意の識別子を保存しません。

REST APIサービスの呼び出し

RESTクライアントまたはcURLコマンドを使用してREST APIサービスを呼び出すことができます。以下の例では、Chrome用のAdvanced RESTクライアントを使用しています。

注:

以下の例では、ホスト名とポート番号を環境に合わせて変更してください。

ログイン

ここに示されている例は、Citrix Cloud APIを介して取得されたトークンを使用してログインする方法を説明しています。

  • URL: https://<host-name>:<port-number>/xenmobile/api/v1/authentication/login/cloud

メソッドタイプ: POST

コンテンツタイプ: application/json

リクエストサンプル:

{
 "bearerToken": "eyJ0eOiJSUzJiibGcI1AiONiJ9.eyJkIjoMDExN1c2VIXiMzNDc1OTk4...qf0iQ"
}
<!--NeedCopy-->

ベアラートークンは、Citrix Cloud API https://trust.citrixworkspacesapi.net/Help/Api/POST-customer-tokens-clientsを使用して取得する必要があります。詳細については、開発者向けドキュメントを参照してください。

レスポンスサンプル:

{
 "auth_token": "q483409eu82mkfrcdiv90iv0gc:q483409eu82mkfrcdiv90iv0gc"
}
<!--NeedCopy-->

関連情報

REST API