box-node-sdk

ExternalUsersManager

Submit job to delete external users

Delete external users from current user enterprise. This will remove each external user from all invited collaborations within the current enterprise.

This operation is performed by calling function submitJobToDeleteExternalUsersV2025R0.

See the endpoint docs at API Reference.

await client.externalUsers.submitJobToDeleteExternalUsersV2025R0({
  externalUsers: [
    new UserReferenceV2025R0({ id: getEnvVar('BOX_EXTERNAL_USER_ID') }),
  ],
} satisfies ExternalUsersSubmitDeleteJobRequestV2025R0);

Arguments

Returns

This function returns a value of type ExternalUsersSubmitDeleteJobResponseV2025R0.