note
2020年1月8日の本番リリース
予定
より、既存のWebHookの一部パラメータが変更され、新たなWebHookが追加されます。
β環境では変更が適用されている為、β環境をご利用の場合は、
をご覧ください。
概要
| Anchor |
|---|
|
|
|
ユーザーのプロフィール情報が更新された際にprofile/update WebHookが発行されます。
| Note |
|---|
プロフィール更新のWebHookは、バージョン2のみ送信されます。 |
以下の操作がプロフィール情報の更新とみなされます。
- アカウント管理画面からユーザー自身がプロフィール情報の更新を行う。
- ドメインユーザー管理画面からドメイン管理者によって従属アカウントのプロフィール情報の更新を行う。
- ドメインユーザー管理画面からドメイン管理者によって従属アカウントの更新インポートを行う。
このWebHookは、該当サービスを複数契約している場合であっても、一つしか発行されません。（サービススクエアごとに発行はされません）
リクエストボディ
以下のJSONフォーマットでCloudGearからCloudGearアプリケーションにHTTPリクエストが送信されます。
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"event": "profile",
"type": "update",
"data": {
"profiles":[{
"type": "UPDATE", // プロビジョニングタイプ
"userinfo": {
"sub": "user1@unirita.co.jp", // UID
"name": "ユニリタ太郎", // 名前
"given_name": "太郎", // 名
"family_name": "ユニリタ", // 姓
"preferred_username": "user1@unirita.co.jp", // UID
"email": "user1@unirita.co.jp", // メールアドレス
"image_url": { // プロフィール画像のパーマネントURL
100: "https://domain/100/uuid",
300: "https://domain/300/uuid",
500: "https://domain/500/uuid"
},
"square_id": "",
"user_attrs": [{ // ユーザー属性
"id": 1,
"name": "attribute_key", // 属性名
"value": "attribute_value", // 属性値
"square_id": "1234567890" // 属性が紐づくスクエアID（スクエアに紐づいていない場合"global"と表示）
}...{}],
"service_roles": [],
"subscription_roles": []
}
}...{}]
}
} |
ユーザーのプロフィール情報が更新された際にprofile/update WebHookが発行されます。
| Note |
|---|
プロフィール更新のWebHookは、バージョン2のみ送信されます。 |
以下の操作がプロフィール情報の更新とみなされます。
- アカウント管理画面からユーザー自身がプロフィール情報の更新を行う。
- ドメインユーザー管理画面からドメイン管理者によって従属アカウントのプロフィール情報の更新を行う。
- ドメインユーザー管理画面からドメイン管理者によって従属アカウントの更新インポートを行う。
このWebHookは、該当サービスを複数契約している場合であっても、一つしか発行されません。（サービススクエアごとに発行はされません）
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": "91018c24-4182-4e20-8509-501471b6304f", // UUID
"event": "profile",
"type": "update",
"created_at": 1576200980964, // 作成日時
"version": 2, // WebHookのバージョン
"data": {
"service_id": 1, // サービスID
"profiles":[{
"type": "UPDATE", // プロビジョニングタイプ
"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,
"image_url": { // プロフィール画像のパーマネントURL
100: "https://domain/100/uuid",
300: "https://domain/300/uuid",
500: "https://domain/500/uuid"
},
"user_attrs": [{ // ユーザー属性
"id": 1,
"name": "attribute_key", // 属性名
"value": "attribute_value", // 属性値
"square_id": "1234567890" // 属性が紐づくスクエアID（スクエアに紐づいていない場合"global"と表示）
}...{}],
"service_roles": [],
"subscription_roles": []
}
}...{}]
}
} |