Appearance

Delete Users ​

Endpoint ​

http
DELETE /unified/user-directory/users/{id}
Integrations supported
  • Adobe Marketo Engage
  • Asana
  • Atlassian
  • Azure Active Directory
  • Box
  • BrowserStack
  • Calendly
  • ClickUp
  • Cloudflare
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Freshdesk
  • GitHub
  • HubSpot
  • Monday.com
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce
  • Sentry
  • Smartsheet
  • Snowflake
  • Tableau
  • Zendesk
  • Zoom

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
remove_from
string
Where to remove the user from
All possible enum values:
  • group
  • organization
Required in
  • Asana
remove_from_id
string
The ID of the group or organization to remove the user from.
Required in
  • Asana
organization_id
string
Integration specific notes
  • ClickUpThe ID of the organization to remove the user from
  • GitHubThe unique identifier of an organization
Required in
  • ClickUp
  • GitHub
workspace_id
string
The unique identifier for the workspace
Required in
  • Monday.com

Response Body ​

id
string
REQUIRED · The unique identifier for a user
Supported in
  • Asana
  • Azure Active Directory
  • Box
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • HubSpot
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
first_name
string
The first name of the user
Supported in
  • Asana
  • Azure Active Directory
  • Cloudflare
  • Dialpad
  • Okta
  • Outreach
  • Salesforce
  • Smartsheet
last_name
string
The last name of the user
Supported in
  • Asana
  • Azure Active Directory
  • Cloudflare
  • Dialpad
  • Okta
  • Outreach
  • Salesforce
  • Smartsheet
name
string
The name of the user
Supported in
  • Asana
  • Azure Active Directory
  • Box
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
username
string
The username of the user
Supported in
  • Datadog
  • Okta
  • Outreach
  • Salesforce
emails
object[]
The emails of the user
Supported in
  • Asana
  • Azure Active Directory
  • Box
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • HubSpot
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
phones
object[]
The phones of the user
Supported in
  • Azure Active Directory
  • Box
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
  • Zendesk
number
string
The phone number
type
string
The type of phone number
status
string
The status of the user. If no clear mapping is available, then the raw value is returned.
All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • Azure Active Directory
  • Box
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
is_email_verified
boolean
Whether the user's email has been verified
Supported in
  • Datadog
is_2fa_enabled
boolean
Whether the user has 2FA enabled
Supported in
  • Cloudflare
  • Zendesk
roles
object[]
The roles of the user
Supported in
  • Azure Active Directory
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • HubSpot
  • Outreach
  • PagerDuty
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
id
string
The unique identifier for a role
name
string
The name of the role
group
string
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
organization
string
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
organizations
object[]
The organizations of the user
Supported in
  • Asana
  • Dialpad
id
string
The unique identifier for an organization
name
string
The name of the organization
licenses
object[]
The licenses of the user or the products the user has access to
Supported in
  • Dialpad
  • Freshdesk
  • Outreach
  • Zendesk
id
string
The unique identifier for a license
name
string
The name of the license
organization
string
The unique identifier of the organization to which the license belongs
last_active_at
string
The date and time the user was last active for the license
groups
object[]
The groups of the user
id
string
The unique identifier for a group
name
string
The name of the group
organization
string
The unique identifier of the organization to which the group belongs
avatar
string
The avatar of the user
Supported in
  • Asana
  • Box
  • Datadog
  • Dialpad
  • PagerDuty
  • Salesforce
  • Zendesk
timezone
string
The timezone of the user
Supported in
  • Box
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce
  • Zendesk
languages
string[]
The languages preferred by the user
Supported in
  • Azure Active Directory
  • Box
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
bio
string
The bio of the user
Supported in
  • Datadog
  • Salesforce
created_at
string
The date and time the user was created
Supported in
  • Azure Active Directory
  • Box
  • Datadog
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
  • Zendesk
updated_at
string
The date and time the user was last updated
Supported in
  • Box
  • Datadog
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
  • Zendesk
last_active_at
string
The date and time the user was last active
Supported in
  • Freshdesk
last_login_at
string
The date and time the user was last logged in
Supported in
  • Azure Active Directory
  • Freshdesk
  • Okta
  • Outreach
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
status_changed_at
string
The date and time the user's status was last changed
Supported in
  • Okta
activated_at
string
The date and time the user was activated
Supported in
  • Dialpad
  • Okta
  • Outreach
remote_data
object
Raw data returned from the remote API call.