Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

 

概要

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

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

 

リクエストボディ

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

event="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", 
        "user_attrs": [{ // ユーザー属性
          "id": 1,
          "name": "attribute_key", // 属性名
          "value": "attribute_value", // 属性値
          "square_id": "1234567890" // 属性が紐づくスクエアID(スクエアに紐づいていない場合"global"と表示)
        }...{}],
        "service_roles": [],
        "subscription_roles": [],
        "image_url": { // プロフィール画像が設定されていない場合は空
          "100":"https://cloudgear-public-prod.s3-ap-northeast-1.amazonaws.com/profile-image/100/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
          "300":"https://cloudgear-public-prod.s3-ap-northeast-1.amazonaws.com/profile-image/300/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
          "500":"https://cloudgear-public-prod.s3-ap-northeast-1.amazonaws.com/profile-image/500/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
        }
      }
    }]
  }
}

後方互換性のため、上記リクエストが失敗した場合、以下のリクエストが送信されます。

idprovisioning(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":{ // ユーザーのスクエア属性
    "属性名": "属性値",
        ...
   }
    }
  }]
}
  • No labels