From d4788b4fc47639812aa981ceec5955e35433a44b Mon Sep 17 00:00:00 2001
From: Ameer Alntsheh <68712253+Abu-Maher@users.noreply.github.com>
Date: Sat, 28 Sep 2024 04:25:09 +0300
Subject: [PATCH] Add clan object to example user data and document clan data
 structure

- Added a new "clan" object to the example user JSON structure, which includes fields for:
  - identity_guild_id
  - identity_enabled
  - tag
  - badge
- Documented the clan data structure with a detailed table explaining each field.
- This change reflects the new clan functionality associated with users and provides clarity on how to integrate this data in future API calls.
---
 docs/resources/User.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/resources/User.md b/docs/resources/User.md
index 8ea71764b4..759b3846e4 100644
--- a/docs/resources/User.md
+++ b/docs/resources/User.md
@@ -47,6 +47,7 @@ There are other rules and restrictions not shared here for the sake of spam and
 | premium_type?           | integer                                                                              | the [type of Nitro subscription](#DOCS_RESOURCES_USER/user-object-premium-types) on a user's account | identify              |
 | public_flags?           | integer                                                                              | the public [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account                  | identify              |
 | avatar_decoration_data? | ?[avatar decoration data](#DOCS_RESOURCES_USER/avatar-decoration-data-object) object | data for the user's avatar decoration                                                                | identify              |
+| clan? | ?[clan](#DOCS_RESOURCES_USER/clan-data-object) object |  data related to the user's clan identity, including guild association, tag, and badge.                                                                | identify              |
 
 ###### Example User
 
@@ -66,6 +67,12 @@ There are other rules and restrictions not shared here for the sake of spam and
   "avatar_decoration_data": {
     "sku_id": "1144058844004233369",
     "asset": "a_fed43ab12698df65902ba06727e20c0e"
+  },
+  "clan": {
+    "identity_guild_id": "1234567890123456789",
+    "identity_enabled": true,
+    "tag": "u0044\u0049\u0053\u0043",
+    "badge": "972a21b5140307824ee09d388620aacd"
   }
 }
 ```
@@ -112,6 +119,19 @@ The data for the user's [avatar decoration](https://support.discord.com/hc/en-us
 | asset  | string    | the [avatar decoration hash](#DOCS_REFERENCE/image-formatting) |
 | sku_id | snowflake | id of the avatar decoration's SKU                              |
 
+### Clan Data Object
+
+The data for a user's [clan](https://support.discord.com/hc/en-us/articles/23187611406999-Guilds-FAQ) configuration.
+
+###### Clan Data Structure
+
+| Field               | Type       | Description                                                                 |
+|---------------------|------------|-----------------------------------------------------------------------------|
+| identity_guild_id    | snowflake  | The unique identifier of the clan's guild or group.                         |
+| identity_enabled     | boolean    | Indicates whether the clan's identity feature is enabled.                   |
+| tag                 | string     | The tag or abbreviation associated with the clan.                           |
+| badge               | string     | The hash of the image or icon representing the clan's badge.                |
+
 ### Connection Object
 
 The connection object that the user has attached.