Versions Compared

Key

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

スクエアからユーザーを削除した際に発行されるWebHookについて説明します。

 

概要

スクエアからユーザーを削除した際にIDProvisioning WebHookが発行されます。

このWebHookには、同時に削除したユーザーの情報がリスト形式で含まれます。

 

リクエストボディ

以下のJSONフォーマットでCloudGearからCloudGearアプリケーションにHTTPリクエストが送信されます。

Code Block
languagejs
titleevent="user", type="provisioning"
{
  "event": "user",
  "type": "provisioning",
  "data": {
    "squareId": "squareId", // 実行対象になるスクエアID
    "users": [{
      "type": "DELETE", // プロビジョニングタイプ
      "userinfo": {
        "sub": "user1@unirita.co.jp", // UID
        "name": "ユニリタ太郎", // 名前
        "given_name": "太郎", // 名
        "family_name": "ユニリタ", // 姓
        "preferred_username": "user1@unirita.co.jp", // UID
        "email": "user1@unirita.co.jp", // メールアドレス
        "square_id": "12345667890", 
        "square_attrs": { // ユーザのスクエア属性
          "属性名": "属性値"
          ...
        },
        "service_roles": [],
        "subscription_roles": []
      }
    }]
  }
}

後方互換性のため、以下のリクエストも同時に送信されます。

Code Block
languagejs
titleidprovisioning(DELETE)
{
  "event":"idprovisioning",
  "data": [{
    "type":"DELETE",
    "userinfo": {
      "sub":"user1@unirita.co.jp", // UID
      "name":"ユニリタ太郎", // 名前
      "given_name":"太郎",  // 名
      "family_name":"ユニリタ", // 性
      "preferred_username":"user1@unirita.co.jp", // UID (MUST NOT Unique)
      "email":"user1@unirita.co.jp", // メールアドレス
      "square_id":"1234567890", // 実行対象になるスクエアID
      "square_attrs":{ // ユーザーのスクエア属性
    "属性名": "属性値",
        ...
   }
    }
  },
  {
    "type":"DELETE",
    "userinfo": {
      "sub":"user2@unirita.co.jp", // UID
      "name":"ユニリタ次郎", // 名前
      "given_name":"次郎",  // 名
      "family_name":"ユニリタ", // 性
      "preferred_username":"user2@unirita.co.jp", // UID (MUST NOT Unique)
      "email":"user2@unirita.co.jp", // メールアドレス
      "square_id":"1234567890", // 実行対象になるスクエアID
      "square_attrs":{ // ユーザーのスクエア属性
    "属性名": "属性値",
        ...
   }
    }
  }]
}