Method: AppEnrollmentsClient#update_app_enrollment

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

#update_app_enrollment(id:, body:) ⇒ Object

Updates an existing App Enrollment with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. For example, you can provide the field name “IsActive” and specify the new value “False”; this API will then change the value of IsActive to false.

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 update

  • body (object) —

    A list of changes to apply to this App Enrollment



53
54
55
56
 
# File 'lib/lockstep_sdk/clients/app_enrollments_client.rb', line 53

def update_app_enrollment(id:, body:)
    path = "/api/v1/AppEnrollments/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end