シトリックスクラウド™

SDKとAPI

  • Citrix Cloud™ は、情報の取得や、複雑で反復的なタスクの自動化に使用できるいくつかのAPIを提供しています。これには以下が含まれます。

  • Citrix Cloud Connector™ のサイレントインストール
  • クラウドライセンス管理のためのレポート作成と利用
  • 顧客のエンタイトルメントステータスの確認
  • Citrix Cloud管理者への通知送信
  • システムログイベントの取得
  • 他のAPIで使用するためのリソースロケーションの詳細取得

いくつかのCitrix Cloudサービスも、情報の取得、データのクエリ、および管理タスクの実行を可能にするSDKとAPIを提供しています。

APIには、セキュアクライアントまたはサービスプリンシパルの両方を通じてアクセスできます。

サービスプリンシパル

Citrix Cloud APIを使用するには、Citrix Cloudに代わってアクセスするサービスプリンシパルを作成する必要があります。サービスプリンシパルを作成するには、Citrix Cloudアカウントの顧客IDを提供する必要があります。顧客IDは、管理コンソールの次の場所にあります。

  • コンソールの右上隅、ユーザー名の下

    User menu with customer ID highlighted

  • アカウント設定ページ

  • Customer menu with Account Settings highlighted
  • APIアクセスページ

    API access example

セキュアクライアント

Citrix Cloud APIを使用するには、Citrix Cloudに代わってアクセスするセキュアクライアントを作成する必要があります。セキュアクライアントを作成するには、Citrix Cloudアカウントの顧客IDを提供する必要があります。顧客IDは、管理コンソールの次の場所にあります。

  • コンソールの右上隅、ユーザー名の下

    User menu with customer ID highlighted

  • アカウント設定ページ

    Customer menu with Account Settings highlighted

  • APIアクセスページ

    API Access page with customer ID highlighted

  • 継承された権限

セキュアクライアントは、Citrix Cloudの単一の管理者と単一の顧客IDに紐付けられています。これは、セキュアクライアントが特定の顧客IDの下で持つ権限と同じレベルの権限を継承することを意味します。したがって、フルアクセス権限がある場合、セキュアクライアントもフルアクセス権限を持ちます。後で権限レベルが引き下げられた場合、すでに作成したセキュアクライアントは自動的に引き下げられた権限を継承します。

  • セキュアクライアントの作成手順については、Citrix DeveloperドキュメントのCitrix Cloud APIの概要を参照してください。

  • クラウドライセンスAPI

エンタープライズのお客様は、クラウドライセンスAPIを使用して、使用状況データのエクスポートや割り当て済みライセンスの解放などの管理タスクを実行できます。Citrixパートナーは、これらのAPIを使用して、オンプレミスのCitrix Virtual Apps and Desktops™ およびCitrix DaaSの概要データと履歴データを取得できます。

詳細については、Citrix DeveloperドキュメントのCitrix Cloudライセンスを管理するAPIを参照してください。

SystemLog API

SystemLog APIを使用すると、指定した期間にCitrix Cloudアカウントで発生したイベントを取得できます。このAPIの使用に関する詳細については、Citrix DeveloperドキュメントのCitrix Cloud - SystemLogを参照してください。

リソースロケーションAPI

リソースロケーションAPIを使用すると、他のアプリケーションやスクリプトで使用するために、リソースロケーションに関する情報を取得できます。たとえば、Citrix Cloudアカウント内の複数のリソースロケーションのいずれかにCitrix Cloud Connectorをサイレントインストールしたいとします。このAPIを使用して、リソースロケーションIDを取得し、インストールスクリプトに渡すことができます。

このAPIの使用に関する詳細については、Citrix DeveloperドキュメントのCitrix Cloud - リソースロケーションを参照してください。

サービスエンタイトルメントAPI

サービスエンタイトルメントAPIは、顧客が使用する権利を持つサービス、各エンタイトルメントの残り日数、および顧客が購入したエンタイトルメントの数量を取得します。このAPIの使用に関する詳細については、Citrix DeveloperドキュメントのCitrix Cloud - サービスエンタイトルメントを参照してください。

通知API

通知APIを使用すると、他のCitrix Cloud管理者にメッセージを送信できます。受信者は、管理コンソールの通知ページを通じてメッセージを受け取ります。このAPIの使用に関する詳細については、通知の作成と表示を参照してください。

その他のサービス向けSDKとAPI

その他のCitrix Cloudサービスで利用可能なSDKとAPIの詳細については、以下の記事を参照してください。

詳細情報

Citrix Cloud APIとセキュアクライアントが、クラウドへの移行やプッシュトークンによる認証の構成などの複雑な操作をどのように支援できるかについては、以下のTech Zone記事を参照してください。

SDKとAPI