Delete user

This API will delete a user using their resourseGuid.

Prerequisites

  • The customer needs to be on Okta
  • The user ResourceGuid (Alumni unique identifier) must be passed on the query parameter.
  • The 'deleteOktaAccount' flag can be passed on the query parameter (default value is false).

Expected return

  • An error in case the system could not opt out the user on the platform or a success message in case the user was successfully opted out.

Notes

  • It is possible to perform the API call without the 'deleteOktaAccount' flag on the query parameters, it will have a value of 'false' as default.
  • The user ResourceGuid can be found on the return of other APIs such as "Create and return a new user" and "Return a list of users".
  • The user ResourceGuid might be seen on user data reports.
  • The ResourceGuid is on the CRM view of the user profile URL:
881