node-zendesknode-zendesk / Exports / clients/core/users
Module: clients/core/users
Table of contents
Classes
Type Aliases
Type Aliases
User
Ƭ User: Object
Type declaration
| Name | Type | Description |
|---|---|---|
active | boolean | - false if the user has been deleted |
alias? | string | - An alias displayed to end users |
chat_only | boolean | - Whether or not the user is a chat-only agent |
created_at | string | - The time the user was created |
custom_role_id? | number | - A custom role if the user is an agent on the Enterprise plan or above |
default_group_id? | number | - The id of the user's default group |
details? | string | - Any details you want to store about the user, such as an address |
email? | string | - The user's primary email address. *Writeable on create only. On update, a secondary email is added. See Email Address |
external_id? | string | - A unique identifier from another system. The API treats the id as case insensitive. Example: "ian1" and "IAN1" are the same value. |
iana_time_zone | string | - The time zone for the user |
id | number | - Automatically assigned when the user is created |
last_login_at | string | - Last time the user signed in to Zendesk Support or made an API request using an API token or basic authentication |
locale? | string | - The user's locale. A BCP-47 compliant tag for the locale. If both "locale" and "locale_id" are present on create or update, "locale_id" is ignored and only "locale" is used. |
locale_id? | number | - The user's language identifier |
moderator? | boolean | - Designates whether the user has forum moderation capabilities |
name | string | - The user's name |
notes? | string | - Any notes you want to store about the user |
only_private_comments? | boolean | - true if the user can only create private comments |
organization_id? | number | - The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization. If updating, see Organization ID |
phone? | string | - The user's primary phone number. See Phone Number below |
photo? | object | - The user's profile picture represented as an Attachment object |
remote_photo_url? | string | - A URL pointing to the user's profile picture. |
report_csv | boolean | - This parameter is inert and has no effect. It may be deprecated in the future. Previously, this parameter determined whether a user could access a CSV report in a legacy Guide dashboard. This dashboard has been removed. See Announcing Guide legacy reporting upgrade to Explore |
restricted_agent? | boolean | - If the agent has any restrictions; false for admins and unrestricted agents, true for other agents |
role? | string | - The user's role. Possible values are "end-user", "agent", or "admin" |
role_type | number | - The user's role id. 0 for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a chat agent added to the Support account as a contributor (Chat Phase 4), 4 for an admin, and 5 for a billing admin |
shared | boolean | - If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only |
shared_agent | boolean | - If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only |
shared_phone_number? | boolean | - Whether the phone number is shared or not. See Phone Number below |
signature? | string | - The user's signature. Only agents and admins can have signatures |
suspended? | boolean | - If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal |
tags? | string[] | - The user's tags. Only present if your account has user tagging enabled |
ticket_restriction? | string | - Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null. "groups" and "assigned" are valid only for agents. If you pass an invalid value to an end user (for example, "groups"), they will be assigned to "requested", regardless of their previous access |
time_zone? | string | - The user's time zone. See Time Zone |
two_factor_auth_enabled | boolean | - If two factor authentication is enabled |
updated_at | string | - The time the user was last updated |
url | string | - The user's API url |
user_fields? | object | - Values of custom fields in the user's profile. See User Fields |
verified? | boolean | - Any of the user's identities is verified. See User Identities |
Defined in
clients/core/users.d.ts:1