Skip to content
DELETE /unified/user-directory/users/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

remove_fromstring

Where to remove the user from

Possible values:
grouporganization
1 supported1 required
Asana
required
remove_from_idstring

The ID of the group or organization to remove the user from.

1 supported1 required
Asana
required
emailsstring

The emails of the user

33 supported1 required
BrowserStack
required
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Domo
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
Heroku
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
PagerDuty
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
SurveySparrow
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

organization_idstring
5 supported5 required3 notes
Cisco Meraki
required
ClickUp
required

The ID of the organization to remove the user from

Elastic Cloud
required
GitHub
required

The unique identifier of an organization

Trello
required

The unique identifier for the organization

workspace_idstring
6 supported5 required3 notes
Cisco Meraki
required
Monday.com
required

The unique identifier for the workspace

Slack Enterprise
required

The unique identifier for a group

Typeform
required

The unique identifier for the workspace

Webflow
required
GitLab
supported
group_id

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

3 supported1 required
Heroku
required
GitLab
supported
Vercel
supported
productstring
Possible values:
azure_active_directoryworkspace
2 supported1 required2 notes
Google
required
workspace

Select the product from which you want to delete the user.

Microsoft 365
supported
azure_active_directory

Select the product for which you want to delete the user.

user_typestring

The type of user

Possible values:
adminend_user
4 supported1 required
Jamf
required
Canva
supported
Dropbox Sign (HelloSign)
supported
Teamwork Spaces
supported
workspace
2 supported2 required
Power BI
required
WordPress
required
hard_deleteboolean

Set to true if you wish to delete user permanently.

1 supported
TeamViewer
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

idstring
required·

The unique identifier for a user

35 supported
Asana
supported
Avalara AvaTax
supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Domo
supported
Freshdesk
supported
GitLab
supported
Dropbox Sign (HelloSign)
supported
Heroku
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
PagerDuty
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
SurveySparrow
supported
Tableau
supported
Teamwork Spaces
supported
Veeva Vault
supported
Zendesk
supported
activated_atstring · date-time

The date and time the user was activated

3 supported
Dialpad
supported
Okta
supported
Outreach
supported
avatarstring

The avatar of the user

11 supported
Asana
supported
Box
supported
Canva
supported
Datadog
supported
Dialpad
supported
PagerDuty
supported
Pipedrive
supported
Salesforce
supported
SurveySparrow
supported
Teamwork Spaces
supported
Zendesk
supported
biostring

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

2 supported
Datadog
supported
Salesforce
supported
created_atstring · date-time

The date and time the user was created

23 supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Datadog
supported
Dialpad
supported
Freshdesk
supported
Heroku
supported
JumpCloud
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
SurveySparrow
supported
Teamwork Spaces
supported
Zendesk
supported
emailsobject[]

The emails of the user

32 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Domo
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
Heroku
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
PagerDuty
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
SurveySparrow
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

external_idstring

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

4 supported
BigPanda
supported
Canva
supported
Miro SCIM
supported
Notion SCIM
supported
first_namestring

The first name of the user

20 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Canva
supported
Cloudflare
supported
Dialpad
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
Teamwork Spaces
supported
groupsobject[]

The groups of the user

9 supported
Asana
supported
BigPanda
supported
Canva
supported
Dropbox Sign (HelloSign)
supported
KnowBe4
supported
Miro SCIM
supported
Notion SCIM
supported
Rootly
supported
Salesloft
supported
idstring

The unique identifier for a group

namestring

The name of the group

organizationstring

The unique identifier of the organization to which the group belongs

identifiersRecord<string, any>

The identifiers of the user.

is_2fa_enabledboolean

Whether the user has 2FA enabled

4 supported
Cloudflare
supported
Heroku
supported
KnowBe4
supported
Zendesk
supported
is_email_verifiedboolean

Whether the user's email has been verified

2 supported
Datadog
supported
SurveySparrow
supported
languagesstring[]

The languages preferred by the user

11 supported
Azure Active Directory
supported
Box
supported
Canva
supported
Dialpad
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
KnowBe4
supported
Microsoft 365
supported
Okta
supported
Outreach
supported
Salesforce
supported
last_active_atstring · date-time

The date and time the user was last active

1 supported
Freshdesk
supported
last_login_atstring · date-time

The date and time the user was last logged in

11 supported
Azure Active Directory
supported
Freshdesk
supported
KnowBe4
supported
Microsoft 365
supported
Okta
supported
Outreach
supported
Pipedrive
supported
Salesforce
supported
Smartsheet
supported
Tableau
supported
Zendesk
supported
last_namestring

The last name of the user

20 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Canva
supported
Cloudflare
supported
Dialpad
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
Teamwork Spaces
supported
licensesobject[]

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

14 supported
Azure Active Directory
supported
Canva
supported
Dialpad
supported
Freshdesk
supported
JumpCloud
supported
KnowBe4
supported
Microsoft 365
supported
Outreach
supported
Pipedrive
supported
Salesloft
supported
Smartsheet
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
idstring

The unique identifier for a license

last_active_atstring · date-time

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

namestring

The name of the license

organizationstring

The unique identifier of the organization to which the license belongs

namestring

The name of the user

32 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Domo
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
Heroku
supported
HubSpot
supported
JumpCloud
supported
juniper-mist
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
PagerDuty
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
SurveySparrow
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
organizationsobject[]

The organizations of the user

4 supported
Asana
supported
Dialpad
supported
JumpCloud
supported
Teamwork Spaces
supported
idstring

The unique identifier for an organization

namestring

The name of the organization

phonesobject[]

The phones of the user

18 supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Dialpad
supported
Freshdesk
supported
JumpCloud
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
SurveySparrow
supported
Zendesk
supported
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

rolesobject[]

The roles of the user

26 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Domo
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
Heroku
supported
HubSpot
supported
juniper-mist
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Outreach
supported
PagerDuty
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
SurveySparrow
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
groupstring

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.

idstring

The unique identifier for a role

namestring

The name of the role

organizationstring

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

workspacestring

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

statusstring

The status of the user. If no clear mapping is available, then the raw value is returned.

Possible values:
activeinactivedeletedinvited
25 supported
Asana
supported
Azure Active Directory
supported
BigPanda
supported
Box
supported
Canva
supported
Cloudflare
supported
Datadog
supported
Dialpad
supported
Freshdesk
supported
Dropbox Sign (HelloSign)
supported
JumpCloud
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Pipedrive
supported
Salesforce
supported
Salesloft
supported
Smartsheet
supported
Tableau
supported
Teamwork Spaces
supported
Zendesk
supported
status_changed_atstring · date-time

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

1 supported
Okta
supported
timezonestring

The timezone of the user

13 supported
Box
supported
Canva
supported
Dialpad
supported
Freshdesk
supported
KnowBe4
supported
Okta
supported
Outreach
supported
PagerDuty
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Zendesk
supported
titlestring

The title of the user

6 supported
Canva
supported
JumpCloud
supported
Kandji
supported
KnowBe4
supported
Microsoft 365
supported
Salesloft
supported
updated_atstring · date-time

The date and time the user was last updated

18 supported
BigPanda
supported
Box
supported
Canva
supported
Datadog
supported
Freshdesk
supported
Heroku
supported
Kandji
supported
KnowBe4
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Pipedrive
supported
Rootly
supported
Salesforce
supported
Salesloft
supported
Teamwork Spaces
supported
Zendesk
supported
urlsobject[]

The URLs of the user

1 supported
Canva
supported
typestring

The type of URL

urlstring

The URL

user_typestring

The type of user

3 supported
Canva
supported
Dropbox Sign (HelloSign)
supported
Teamwork Spaces
supported
usernamestring

The username of the user

11 supported
BigPanda
supported
Canva
supported
Datadog
supported
Domo
supported
JumpCloud
supported
Microsoft 365
supported
Miro SCIM
supported
Notion SCIM
supported
Okta
supported
Outreach
supported
Salesforce
supported
workspacesobject[]

The workspaces of the user

idstring

The unique identifier for a workspace

namestring

The name of the workspaces

curl -X DELETE 'https://api.truto.one/unified/user-directory/users/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/user-directory/users/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/user-directory/users/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.delete(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.delete(
  'user-directory',
  'users',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.delete(
        "user-directory",
        "users",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())