Enrollment

For claiming (or transferring) device ownership.

Usage

from mbed_cloud import EnrollmentAPI
api = EnrollmentAPI()

api.add_enrollment_claim(enrollment_identity='your enrollment identity here')

Reference

class mbed_cloud.enrollment.EnrollmentAPI(params=None)

API reference for the Enrollment API.

add_enrollment_claim(**kwargs)

Add

delete_enrollment_claim(id, **kwargs)

Delete

get_enrollment_claim(id, **kwargs)

Get

list_enrollment_claims(**kwargs)

List

class mbed_cloud.enrollment.EnrollmentClaim(dictionary)

Describes device object from the catalog.

account_id

Gets the account_id of this EnrollmentIdentity.

Returns:The account_id of this EnrollmentIdentity.
Return type:str
claim_id

Gets the claim_id of this EnrollmentIdentity.

Enrollment identity.

Returns:The claim_id of this EnrollmentIdentity.
Return type:str
claimed_at

Gets the claimed_at of this EnrollmentIdentity.

The time of claiming the device to be assigned to the account.

Returns:The claimed_at of this EnrollmentIdentity.
Return type:datetime
created_at

Gets the created_at of this EnrollmentIdentity.

The time of the enrollment identity creation.

Returns:The created_at of this EnrollmentIdentity.
Return type:datetime
device_id

Gets the enrolled_device_id of this EnrollmentIdentity.

Enrolled device internal ID

Returns:The enrolled_device_id of this EnrollmentIdentity.
Return type:str
expires_at

Gets the expires_at of this EnrollmentIdentity.

The enrollment claim expiration time. If the device does not connect to Mbed Cloud before the expiration, the claim is removed without a separate notice

Returns:The expires_at of this EnrollmentIdentity.
Return type:datetime
id

Gets the id of this EnrollmentIdentity.

Enrollment identity internal id

Returns:The id of this EnrollmentIdentity.
Return type:str