Skip to content

Commit c72f576

Browse files
pwsegpwseg
committed
clean up users table
1 parent 5eb849e commit c72f576

File tree

1 file changed

+33
-32
lines changed
  • src/connections/sources/catalog/cloud-apps/zendesk

1 file changed

+33
-32
lines changed

‎src/connections/sources/catalog/cloud-apps/zendesk/index.md‎

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -83,40 +83,41 @@ This collection contains information about Zendesk groups.
8383
| `updated_at` | The date and time the group was last updated. |
8484
| `received_at` | Timestamp added when data reaches the Segment API. |
8585

86-
8786
### users
8887

89-
| Property | Description |
90-
| --------------- | ----------------------------------------------------------------- |
91-
| id | This is automatically assigned when the user is created. |
92-
| url | Segment sets the “url” field users see in their Warehouse to equal the “id” from Zendesk, rather than the “url” field. |
93-
| name | The name of the user. |
94-
| email | The primary email address of the user. |
95-
| time_zone | The time-zone of this user. |
96-
| phone | The primary phone number of this user. |
97-
| locale_id | The language identifier of this user. |
98-
| locale | The locale for this user. |
99-
| organization_id | The ID of the organization that this user is associated with. |
100-
| role | The role of the user. Possible values: "end-user", "agent", "admin". |
101-
| verified | The user's primary identity is verified or not. |
102-
| external_id | A unique identifier from another system. The API treats the ID as case insensitive. Example: ian1 and Ian1 are the same user. |
103-
| alias | An alias displayed to end users. |
104-
| active | This is set to false if the user has been deleted. |
105-
| shared | If the user is a shared agent from different Zendesk Support instance. Ticket sharing accounts only. |
106-
| last_login_at | The last time the user signed in to Zendesk Support. |
107-
| two_factor_auth_enabled | If two factor authentication is enabled. |
108-
| signature | The user's signature. Only agents and admins can have signatures. |
109-
| details | Any details you want to store about the user, such as an address. |
110-
| notes | Any notes you want to store about the user. |
111-
| custom_role_id | A custom role if the user is an agent on the Enterprise plan. |
112-
| moderator | Designates whether the user has forum moderation capabilities. |
113-
| ticket_restriction | Specifies which tickets the user has access to. Possible values are: “organization”, “groups”, “assigned”, “requested”, null. |
114-
| only_private_comments | This is set to true if the user can only create private comments. |
115-
| restricted_agent | If the agent has any restrictions: This is set to false for admins and unrestricted agents, true for other agents. |
116-
| suspended | If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal. |
117-
| chat_only | Whether or not the user is a chat-only agent. |
118-
| updated_at | The date and time of the user's last update. |
119-
| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. |
88+
This collection contains information about Zendesk users.
89+
90+
| Property | Description |
91+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
92+
| `id` | Automatically assigned when a user is created. |
93+
| `url` | Segment sets this field to the Zendesk `id`, not the original Zendesk `url`. |
94+
| `name` | The user’s full name. |
95+
| `email` | The user’s primary email address. |
96+
| `time_zone` | The user’s time zone. |
97+
| `phone` | The user’s primary phone number. |
98+
| `locale_id` | The language identifier for the user. |
99+
| `locale` | The user’s locale. |
100+
| `organization_id` | The ID of the organization the user belongs to. |
101+
| `role` | The user’s role. Possible values: `end-user`, `agent`, `admin`. |
102+
| `verified` | Indicates whether the user’s primary identity is verified. |
103+
| `external_id` | A unique identifier from another system. Treated as case-insensitive (for example, `ian1` and `Ian1` refer to the same user). |
104+
| `alias` | An alias displayed to end users. |
105+
| `active` | Set to `false` if the user has been deleted. |
106+
| `shared` | Indicates whether the user is a shared agent from another Zendesk instance (ticket sharing accounts only). |
107+
| `last_login_at` | The date and time of the user’s last login. |
108+
| `two_factor_auth_enabled` | Indicates whether two-factor authentication is enabled. |
109+
| `signature` | The user’s signature (agents and admins only). |
110+
| `details` | Additional details about the user, such as an address. |
111+
| `notes` | Notes stored about the user. |
112+
| `custom_role_id` | The custom role ID if the user is an agent on the Enterprise plan. |
113+
| `moderator` | Indicates whether the user has forum moderation permissions. |
114+
| `ticket_restriction` | Specifies which tickets the user can access. Possible values: `organization`, `groups`, `assigned`, `requested`, or `null`. |
115+
| `only_private_comments` | Set to `true` if the user can only create private comments. |
116+
| `restricted_agent` | Indicates whether the agent has restrictions. `false` for admins and unrestricted agents, `true` for restricted agents. |
117+
| `suspended` | Indicates whether the agent is suspended. Tickets from suspended users are also suspended. |
118+
| `chat_only` | Indicates whether the user is a chat-only agent. |
119+
| `updated_at` | The date and time the user was last updated. |
120+
| `received_at` | Timestamp added when data reaches the Segment API. |
120121

121122
### tickets
122123

0 commit comments

Comments
 (0)