このセクションでは、CloudGearアプリケーションがCloudGearのWebHookを受け取る為の実装について説明いたします。
WebHookの種類
WebHookは、いくつかのタイプを持ちます。
Version1
| タイプ | 説明 |
|---|---|
| idprovisioning | ユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。 |
| squareprovisioning | スクエアに対する変更、または契約状態の変更によって発行されるWebHookです。 |
Version2
| イベント | タイプ | 説明 |
|---|---|---|
| user | provisioning | ユーザーの追加・削除などユーザーの存在に関連した変更が発生した場合に発行されるWebHookです。 |
| user | role-assign | サブスクリプションを管理する契約管理者の任命・解任が発生した場合に発行されるWebHookです。 |
| profile | update | ユーザー情報の変更が発生した場合に発行されるWebHookです。 このWebHookは、ユーザーが契約しているサービスあたり1回しか発行されません。 |
WebHookの発行タイミング
WebHookは、以下のタイミングで発行されます。
タイミング | 発行されるWebHook発行されるWebHookのイベントタイプ | ||
|---|---|---|---|
サービスの申し込みsquareprovisioning（ADD）、idprovisioning（ADD） | squareprovisioning.ADD、idprovisioning.ADD | ||
サービス利用者による契約プランの更新squareprovisioning（UPDATE） | squareprovisioning.UPDATE | ||
サービスの解約squareprovisioning（DELETE）、idprovisioning（DELETE） | squareprovisioning.DELETE、idprovisioning.DELETE | ||
スクエアにユーザーを招待
| Version1
Version2
| ||
スクエアからユーザーを削除 | Version1
Version2
| ||
| 契約管理者の任命 | user/.role-assign | ||
| 契約管理者の解任 | user/.role-assign | ||
| ユーザー情報の更新 | profile/.update |
WebHookの実装
以下のページにて、具体的なWebHookの設定方法ならびに各タイミングで発行されるWebHookのリクエストボディに関して説明します。
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|