Archive User

DELETE /auth/users/{userId}

Archive a specific user in the caller's org

• User action signature required. See User Action Signing for more information.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Required Permissions

Name	Conditions
Auth:Users:Delete	Always Required

Parameters

userId *	the ID of the user to archive

Example

/auth/users/us-em7bu-m6c48-hdqoobj7dj24pko

Responses

• See Common Errors for common errors.

• See User Management Errors for user management specific errors.

200

Success - The user that was updated

{
    "userId": "us-xxxx-xxxx-xxxxxxxx",
    "kind": "CustomerEmployee",
    "username": "[email protected]",
    "name": "Elon Musk",
    "orgId": "or-xxxx-xxxx-xxxxxxxx",
    "isActive": false,
    "isRegistered": true,
    "permissionAssignments": [],
}