Citrix Endpoint Management

REST API

Endpoint Management REST APIを使用すると、以下を実行できます:

  • Endpoint Managementコンソールで公開されるサービスを呼び出すことができます
  • RESTクライアントを使用して、RESTサービスを呼び出すことができます

APIについて、サービスを呼び出すためにEndpoint Managementコンソールにサインオンする必要はありません。

現在使用できるAPIの全一覧については、『Public API for REST Services』(PDF)をダウンロードしてください。

ワークスペースが有効になっているEndpoint Management環境の場合、モバイルおよびデスクトップのエンドポイントデバイスを管理し、ワークスペースアプリの設定を構成するAPIがあります。https://developer.cloud.com/citrixworkspaceに移動し、[Citrix Endpoint Management] > [Mobile Application Integration] の順に選択します。

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

REST APIへのアクセスには、以下の権限のうち1つが必要です。

  • Citrix Cloud管理者
  • 役割ベースのアクセス構成の一部として設定されたパブリックAPIアクセス権限詳しくは、「RBACを使用した役割の構成」を参照してください。
  • スーパーユーザー権限

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

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

次に、セキュアクライアントIDとクライアントシークレットが作成されます。この情報のコピーをダウンロードし、参照用にオフラインで安全に保管してください。この情報はCitrix Cloudに保存されないため、ダイアログボックスを閉じるとアクセスできなくなります。

REST APIサービスを呼び出すには

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

注:

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

ログイン

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

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

メソッドの種類:POST

コンテンツの種類:application/json

リクエストのサンプル:

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

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

応答サンプル:

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

関連情報

REST API