Appearance

Delete Users ​

Endpoint ​

http
DELETE /unified/user-directory/users/{id}
Integrations supported
  • Adobe Marketo Engage
  • Airtable
  • Airtable SCIM
  • Asana
  • Atlassian
  • Auth0
  • Azure Active Directory
  • BigPanda
  • Box
  • BrowserStack
  • Calendly
  • Canva
  • Cisco Meraki
  • ClickUp
  • Cloudflare
  • Confluent
  • CrowdStrike
  • Databricks
  • Datadog
  • Dialpad
  • DocuSign
  • Domo
  • Dropbox - Business
  • Elastic Cloud
  • Figma
  • Figma SCIM
  • Files.com
  • Fivetran
  • Freshdesk
  • Freshservice
  • GitHub
  • GitLab
  • Google Workspace
  • Dropbox Sign (HelloSign)
  • Help Scout
  • Heroku
  • HubSpot
  • Ironclad
  • Jamf
  • JFrog
  • Jostle SCIM
  • JumpCloud
  • KnowBe4 SCIM
  • LastPass
  • Looker
  • ManageEngine ServiceDesk Plus
  • Miro SCIM
  • Monday.com
  • Monday.com SCIM
  • New Relic
  • Notion SCIM
  • Okta
  • Outreach
  • PagerDuty
  • Pendo SCIM
  • Pipedrive
  • Pipeliner
  • Postman SCIM
  • Power BI
  • Qlik Sense
  • Qualtrics CoreXM
  • Rootly
  • Salesforce
  • Salesloft
  • Segment
  • Sentry
  • Slack Enterprise
  • Smartsheet
  • Snowflake
  • SolarWinds Service Desk
  • SurveySparrow
  • Tableau
  • TeamViewer
  • Teamwork Desk
  • Teamwork Project Management
  • Teamwork Spaces
  • Trello
  • Typeform
  • Veeva Vault
  • Vercel
  • Webex
  • Webflow
  • WordPress
  • Zendesk
  • Zoho Bigin
  • Zoom

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
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
  • GitLabEither of organization or workspace is required.
  • TrelloThe unique identifier for the organization
Required in
  • Cisco Meraki
  • ClickUp
  • Elastic Cloud
  • GitHub
  • Trello
Supported in
  • GitLab
workspace_id
string
Integration specific notes
  • GitLabEither of organization or workspace is required.
  • Monday.comThe unique identifier for the workspace
  • TypeformThe unique identifier for the workspace
  • Slack EnterpriseThe unique identifier for a group
Required in
  • Cisco Meraki
  • Monday.com
  • Slack Enterprise
  • Typeform
  • Webflow
Supported in
  • GitLab
emails
string

The emails of the user

Required in
  • BrowserStack
group_id

Set this value if you want to delete the user from a group.

Required in
  • Heroku
Supported in
  • Vercel
workspace
Required in
  • Power BI
  • WordPress
hard_delete
boolean

Set to true if you wish to delete user permanently.

Supported in
  • TeamViewer

Response Body ​

id
string
REQUIRED · 

The unique identifier for a user

Supported in
  • Asana
  • Azure Active Directory
  • BigPanda
  • Box
  • Canva
  • Cloudflare
  • Datadog
  • Dialpad
  • Domo
  • Freshdesk
  • GitLab
  • Dropbox Sign (HelloSign)
  • Heroku
  • HubSpot
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • Smartsheet
  • SurveySparrow
  • Tableau
  • Teamwork Spaces
  • Veeva Vault
  • Zendesk
external_id
string

The external identifier for a user. This is set when the SCIM API is being used.

Supported in
  • BigPanda
  • Canva
  • Miro SCIM
  • Notion SCIM
identifiers
object

The identifiers of the user.

first_name
string

The first name of the user

Supported in
  • Asana
  • Azure Active Directory
  • BigPanda
  • Canva
  • Cloudflare
  • Dialpad
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Rootly
  • Salesforce
  • Salesloft
  • Smartsheet
  • Teamwork Spaces
last_name
string

The last name of the user

Supported in
  • Asana
  • Azure Active Directory
  • BigPanda
  • Canva
  • Cloudflare
  • Dialpad
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Rootly
  • Salesforce
  • Salesloft
  • Smartsheet
  • Teamwork Spaces
title
string

The title of the user

Supported in
  • Canva
  • JumpCloud
  • Salesloft
name
string

The name of the user

Supported in
  • Asana
  • Azure Active Directory
  • BigPanda
  • Box
  • Canva
  • Cloudflare
  • Datadog
  • Dialpad
  • Domo
  • Freshdesk
  • Dropbox Sign (HelloSign)
  • Heroku
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • Smartsheet
  • SurveySparrow
  • Tableau
  • Teamwork Spaces
  • Zendesk
username
string

The username of the user

Supported in
  • BigPanda
  • Canva
  • Datadog
  • Domo
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Salesforce
emails
object[]

The emails of the user

Supported in
  • Asana
  • Azure Active Directory
  • BigPanda
  • Box
  • Canva
  • Cloudflare
  • Datadog
  • Dialpad
  • Domo
  • Freshdesk
  • Dropbox Sign (HelloSign)
  • Heroku
  • HubSpot
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • Smartsheet
  • SurveySparrow
  • Tableau
  • Teamwork Spaces
  • 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
  • BigPanda
  • Box
  • Canva
  • Dialpad
  • Freshdesk
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Pipedrive
  • Rootly
  • Salesforce
  • SurveySparrow
  • Zendesk
number
string

The phone number

extension
string

The extension of 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
  • Asana
  • Azure Active Directory
  • BigPanda
  • Box
  • Canva
  • Cloudflare
  • Datadog
  • Dialpad
  • Freshdesk
  • Dropbox Sign (HelloSign)
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Pipedrive
  • Salesforce
  • Salesloft
  • Smartsheet
  • Tableau
  • Teamwork Spaces
  • Zendesk
is_email_verified
boolean

Whether the user's email has been verified

Supported in
  • Datadog
  • SurveySparrow
is_2fa_enabled
boolean

Whether the user has 2FA enabled

Supported in
  • Cloudflare
  • Heroku
  • Zendesk
roles
object[]

The roles of the user

Supported in
  • Azure Active Directory
  • BigPanda
  • Canva
  • Cloudflare
  • Datadog
  • Dialpad
  • Domo
  • Freshdesk
  • Dropbox Sign (HelloSign)
  • Heroku
  • HubSpot
  • Miro SCIM
  • Notion SCIM
  • Outreach
  • PagerDuty
  • Salesforce
  • Salesloft
  • Smartsheet
  • SurveySparrow
  • Tableau
  • Teamwork Spaces
  • 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.

workspace
string

The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.

organizations
object[]

The organizations of the user

Supported in
  • Asana
  • Dialpad
  • JumpCloud
  • Teamwork Spaces
id
string

The unique identifier for an organization

name
string

The name of the organization

user_type
string

The type of user

Supported in
  • Canva
  • Dropbox Sign (HelloSign)
  • Teamwork Spaces
licenses
object[]

The licenses of the user or the products the user has access to

Supported in
  • Azure Active Directory
  • Canva
  • Dialpad
  • Freshdesk
  • JumpCloud
  • Outreach
  • Pipedrive
  • Salesloft
  • Smartsheet
  • Tableau
  • Teamwork Spaces
  • 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 · date-time

The date and time the user was last active for the license

groups
object[]

The groups of the user

Supported in
  • BigPanda
  • Canva
  • Dropbox Sign (HelloSign)
  • Miro SCIM
  • Notion SCIM
  • Rootly
  • Salesloft
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

workspaces
object[]

The workspaces of the user

id
string

The unique identifier for a workspace

name
string

The name of the workspaces

avatar
string

The avatar of the user

Supported in
  • Asana
  • Box
  • Canva
  • Datadog
  • Dialpad
  • PagerDuty
  • Pipedrive
  • Salesforce
  • SurveySparrow
  • Teamwork Spaces
  • Zendesk
timezone
string

The timezone of the user

Supported in
  • Box
  • Canva
  • Dialpad
  • Freshdesk
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • Zendesk
languages
string[]

The languages preferred by the user

Supported in
  • Azure Active Directory
  • Box
  • Canva
  • Dialpad
  • Freshdesk
  • Dropbox Sign (HelloSign)
  • Okta
  • Outreach
  • Salesforce
bio
string

The bio of the user. Usually a short description set by the user about them.

Supported in
  • Datadog
  • Salesforce
created_at
string · date-time

The date and time the user was created

Supported in
  • Azure Active Directory
  • BigPanda
  • Box
  • Canva
  • Datadog
  • Dialpad
  • Freshdesk
  • Heroku
  • JumpCloud
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • SurveySparrow
  • Teamwork Spaces
  • Zendesk
updated_at
string · date-time

The date and time the user was last updated

Supported in
  • BigPanda
  • Box
  • Canva
  • Datadog
  • Freshdesk
  • Heroku
  • Miro SCIM
  • Notion SCIM
  • Okta
  • Outreach
  • Pipedrive
  • Rootly
  • Salesforce
  • Salesloft
  • Teamwork Spaces
  • Zendesk
last_active_at
string · date-time

The date and time the user was last active

Supported in
  • Freshdesk
last_login_at
string · date-time

The date and time the user was last logged in

Supported in
  • Azure Active Directory
  • Freshdesk
  • Okta
  • Outreach
  • Pipedrive
  • Salesforce
  • Smartsheet
  • Tableau
  • Zendesk
status_changed_at
string · date-time

The date and time the user's status was last changed

Supported in
  • Okta
activated_at
string · date-time

The date and time the user was activated

Supported in
  • Dialpad
  • Okta
  • Outreach
urls
object[]

The URLs of the user

Supported in
  • Canva
url
string

The URL

type
string

The type of URL

remote_data
object

Raw data returned from the remote API call.