Delete Users

Endpoint

http

DELETE /unified/user-directory/users/{id}

Integrations supported

Adobe Marketo Engage
Airtable
Airtable SCIM
Asana
Atlassian
Azure Active Directory
Box
BrowserStack
Calendly
Canva
ClickUp
Cloudflare
Databricks
Datadog
Dialpad
DocuSign
Dropbox - Business
Figma
Fivetran
Freshdesk
GitHub
Google Workspace
HubSpot
Jamf
JFrog
Looker
ManageEngine ServiceDesk Plus
Monday.com
Monday.com SCIM
New Relic
Okta
Outreach
PagerDuty
Postman SCIM
Power BI
Qlik Sense
Salesforce
Segment
Sentry
Smartsheet
Snowflake
Tableau
Trello
Typeform
Vercel
Zendesk
Zoom

Path parameters

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 will return the response with unified mappings applied.
raw will return the raw response from the remote API.
normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:

unified
raw
normalized

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
TrelloThe unique identifier for the organization

Required in

ClickUp
GitHub
Trello

emails

string

The emails of the user

Required in

BrowserStack

workspace_id

string

The unique identifier for the workspace

Required in

Monday.com
Typeform

groups

array

Either one of groups or workspace is required.

Supported in

Vercel

workspace

Either one of groups or workspace is required.

Required in

Power BI

Supported in

Vercel

Response Body

string

REQUIRED ·

The unique identifier for a user

Supported in

Asana
Azure Active Directory
Box
Canva
Cloudflare
Datadog
Dialpad
Freshdesk
HubSpot
Okta
Outreach
PagerDuty
Salesforce
Smartsheet
Tableau
Zendesk

external_id

string

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

Supported in

Canva

identifiers

object

The identifiers of the user.

first_name

string

The first name of the user

Supported in

Asana
Azure Active Directory
Canva
Cloudflare
Dialpad
Okta
Outreach
Salesforce
Smartsheet

last_name

string

The last name of the user

Supported in

Asana
Azure Active Directory
Canva
Cloudflare
Dialpad
Okta
Outreach
Salesforce
Smartsheet

title

string

The title of the user

Supported in

Canva

name

string

The name of the user

Supported in

Asana
Azure Active Directory
Box
Canva
Cloudflare
Datadog
Dialpad
Freshdesk
Okta
Outreach
PagerDuty
Salesforce
Smartsheet
Tableau
Zendesk

username

string

The username of the user

Supported in

Canva
Datadog
Okta
Outreach
Salesforce

emails

object[]

The emails of the user

Supported in

Asana
Azure Active Directory
Box
Canva
Cloudflare
Datadog
Dialpad
Freshdesk
HubSpot
Okta
Outreach
PagerDuty
Salesforce
Smartsheet
Tableau
Zendesk

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
Canva
Dialpad
Freshdesk
Okta
Outreach
Salesforce
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

Azure Active Directory
Box
Canva
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
Canva
Cloudflare
Datadog
Dialpad
Freshdesk
HubSpot
Outreach
PagerDuty
Salesforce
Smartsheet
Tableau
Zendesk

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

string

The unique identifier for an organization

name

string

The name of the organization

user_type

string

The type of user

Supported in

Canva

licenses

object[]

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

Supported in

Azure Active Directory
Canva
Dialpad
Freshdesk
Outreach
Tableau
Zendesk

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

Canva

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
Canva
Datadog
Dialpad
PagerDuty
Salesforce
Zendesk

timezone

string

The timezone of the user

Supported in

Box
Canva
Dialpad
Freshdesk
Okta
Outreach
PagerDuty
Salesforce
Zendesk

languages

string[]

The languages preferred by the user

Supported in

Azure Active Directory
Box
Canva
Dialpad
Freshdesk
Okta
Outreach
Salesforce

bio

string

The bio of the user

Supported in

Datadog
Salesforce

created_at

string · date-time

The date and time the user was created

Supported in

Azure Active Directory
Box
Canva
Datadog
Dialpad
Freshdesk
Okta
Outreach
Salesforce
Zendesk

updated_at

string · date-time

The date and time the user was last updated

Supported in

Box
Canva
Datadog
Freshdesk
Okta
Outreach
Salesforce
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
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.