Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

このセクションでは、CloudGearアプリケーションCloudGearWebHookを受け取る為の実装について説明いたします。


WebHookについて

CloudGearには、サービススクエアが作成/削除されたときや、ユーザースクエアに加入/脱退したときなどに、CloudGearアプリケーションのバックエンドサーバーにその情報を伝えるための仕組みが存在します。

WebHookには、送信バージョンがあります。
バージョンによって、送信されるJSONインタフェースが異なります。(後方互換のため、Version1で送信されていた内容も別途送信いたします)


WebHookの種類

WebHookは、いくつかのタイプを持ちます。

Version1

タイプ説明
idprovisioningユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。
squareprovisioningスクエアに対する変更、または契約状態の変更によって発行されるWebHookです。

Version2

イベントタイプ説明
userprovisioningユーザーの追加・削除などユーザーの存在に関連した変更が発生した場合に発行されるWebHookです。
userrole-assignサブスクリプションを管理する契約管理者の任命・解任が発生した場合に発行されるWebHookです。
profileupdateユーザー情報の変更が発生した場合に発行されるWebHookです。
このWebHookは、ユーザーが契約しているサービスあたり1回しか発行されません。


 

WebHookの発行タイミング

WebHookは、以下のタイミングで発行されます。

タイミング

発行されるWebHook

サービスの申し込み

squareprovisioning(ADD)、idprovisioning(ADD)

サービス利用者による契約プランの更新

squareprovisioning(UPDATE)

サービスの解約

squareprovisioning(DELETE)、idprovisioning(DELETE)

スクエアにユーザーを招待

Note

招待されたユーザーがスクエアへの参加を承認した段階で発行されます。


Version1

  • idprovisioning(ADD)

Version2

  • user/provisioning

スクエアからユーザーを削除

Version1

  • idprovisioning(DELETE)

Version2

  • user/provisioning
契約管理者の任命user/role-assign
契約管理者の解任user/role-assign
ユーザー情報の更新profile/update


 

WebHookの実装

以下のページにて、具体的なWebHookの設定方法ならびに各タイミングで発行されるWebHookのリクエストボディに関して説明します。

Child pages (Children Display)
alltrue
styleh3