Method: AppEnrollmentsClient#delete_app_enrollment

Defined in:
lib/lockstep_sdk/clients/app_enrollments_client.rb

#delete_app_enrollment(id:, remove_enrollment_data:) ⇒ Object

Deletes the App Enrollment referred to by this unique identifier. An App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Lockstep Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.

See [Applications and Enrollments](developer.lockstep.io/docs/applications-and-enrollments) for more information.

Parameters:

  • id (uuid) —

    The unique ID number of the App Enrollment to delete

  • remove_enrollment_data (boolean) —

    Option to remove all associated app enrollment data when deleting app enrollment (default false)



65
66
67
68
69
 
# File 'lib/lockstep_sdk/clients/app_enrollments_client.rb', line 65

def delete_app_enrollment(id:, remove_enrollment_data:)
    path = "/api/v1/AppEnrollments/#{id}"
    params = {:removeEnrollmentData => remove_enrollment_data}
    @connection.request(:delete, path, nil, params)
end