スクエアにユーザーを招待し、そのユーザーがスクエアへの参加を承認した際に発行されるWebHookについて説明します。

概要

スクエアにユーザーを招待し、そのユーザーがスクエアへの参加を承認した際にユーザー追加のWebHookが発行されます。

送信されるWebHookの種類はバージョンにより異なります。

ユーザー追加のWebHookは、以下の2種類です。

UserProvisioning(Version2)
IDProvisioning(Version1)

招待したユーザーが参加を拒否した場合、このWebHookは発行されません。

ユーザー追加のWebHookには、招待されたユーザーの情報が含まれます。

リクエストボディ

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

event="user", type="provisioning"

{
  "id": "91018c24-4182-4e20-8509-501471b6304e" // UUID
  "event": "user",
  "type": "provisioning",
  "cratedAt": 1576200980964, // 作成日時
  "version": 2
  "data": {
    "square_id": "square_id", // 実行対象になるスクエアID
    "service_id": "service_id", // サービスID
    "subscription_id": "subscription_id", // 契約ID
    "users": [{
      "action": "ADD", // プロビジョニングタイプ
      "userinfo": {
        "sub": "user1@unirita.co.jp", // UID
        "name": "ユニリタ太郎", // 名前
        "given_name": "太郎", // 名
        "family_name": "ユニリタ", // 姓
        "preferred_username": "user1@unirita.co.jp", // UID
        "email": "user1@unirita.co.jp", // メールアドレス
        "account_type": "individual",
        "company_name": null,
        "domain_id": "cloudgear.services", // 所属するドメインID
        "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"
        }
      }
    }]
  }
}

event="idprovisioning"

{
  "event":"idprovisioning",
  "version": 1
  "data": [{
    "type":"ADD", // 操作タイプ
    "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": "12345667890", // 実行対象になるスクエアID
      "square_attrs": { // ユーザのスクエア属性
        "属性名": "属性値",
        ...
      }
    }
  }]
}