Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Users

Pseudonymize user

🔑

Required OAuth scope: users:write.

Removes all personal information from a previously deleted user. The first name, last name, email, and username are replaced with random, irreversible alphanumeric strings. Custom field values are deleted permanently. The user ID remains unchanged, so this is not full GDPR anonymization. If 'deleteExternalIds' is set to true, the user's external identifiers are deleted.

put/api/v2/users/{userId}/pseudonymize

Path parameters

userIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the user.

Query parameters

deleteExternalIds'true' | 'false'

If true, user's external identifiers (identifier mappings for third-party platforms) are deleted. If false (or not provided), they are kept.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns the pseudonymized user.

_idstring ObjectId required

The unique ID of the user.

mailstring

The email address of the user.

usernamestring

The username that can be used to log in if the company allows it.

status'active' | 'invited' | 'deleted' required

The status of the user.

lang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'vi' required

The default language of the user, in a bigram format (en, fr, de, etc.).

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

jobstring

The role title of the user.

organizationstring

The organization that the user belongs to.

phonestring

The phone number of the user.

customstring

The value of the Additional information field in the user’s profile. This is not the value of the custom fields associated with the user.

deletedAtstring[]

The list of dates and times when the user’s profile was soft deleted, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

primaryGroupIdstring ObjectId

The unique ID of the primary group of the user.

reactivatedAtstring[]

The list of dates and times when the user’s profile was reactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

lastLoginDatestring date-time

The date and time when the user last logged in, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

toBeDeactivatedAtstring date-time

The date and time when the user will be deactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

profileImageIdstring ObjectId

The unique ID of the profile image of the user.

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "mail": "john.smith@yopmail.com",
  "username": "johnsmith",
  "firstName": "John",
  "lastName": "Smith",
  "job": "Engineer",
  "organization": "360Learning",
  "phone": "+33123456789",
  "custom": "Half-time worker",
  "primaryGroupId": "507f1f77bcf86cd799439011",
  "profileImageId": "507f1f77bcf86cd799439011"
}