Versions Compared

Old Version 6

changes.mady.by.user DiceK Mikami (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user 二宮力也

Saved on

Key

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

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

　

概要

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



Anchor
概要(ベータ環境)
概要(ベータ環境)
概要

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

Note

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

ユーザー削除のWebHookは、以下の2種類になります。

  • UserProvisioning(Version2)
  • IDProvisioning(Version1)

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

　


リクエストボディ

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

Code Block
languagejs
titleevent="user", type="provisioning"
{
  "id": "91018c24-4182-4e20-8509-501471b6304e" // UUID
  "event": "user",
  "type": "provisioning",
  "cratedAt": 1576200980964, // 作成日時
  "version": 2
  "data": {
    "squareIdsquare_id": "squareIdsquare_id", // 実行対象になるスクエアID
    "service_id": "service_id", // サービスID
    "subscription_id": "subscription_id", // 契約ID
    "users": [{
      "typeaction": "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"account_type": "individual",
        "company_name": null,
        "domain_id": "12345667890cloudgear.services", // 所属するドメインID
        "squareuser_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"
        }
      }
    }]
  }
}

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


Code Block
languagejs
titleidprovisioning(DELETE)
{
  "event":"idprovisioning",
  "version": 1,
  "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":{ // ユーザーのスクエア属性
　　　　"属性名": "属性値",
        ...
　　　}
    }
  }]
}