Migrating Existing Unmanaged Access Codes

Learn how to migrate existing lock access codes into Seam

Overview

Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we will help you keep any existing access codes on devices, and transition those codes to ones managed by your Seam workspace.

If migrating existing codes into your Seam workspace is not possible, you can still get a list of these existing codes, and replace them with new access codes managed by your Seam workspace.

Unmanaged Access Codes

Seam differentiates between managed access codes and unmanaged access codes. When you create an access code on a device in Seam, it is created as a managed code. Codes that exist on a device that were not created on Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes to:

• Viewing a list of the unmanaged codes on a device

• Converting an unmanaged code into a managed code

• Deleting an unmanaged code

Strictly speaking, unmanaged codes are any codes on a device that were not created by the current workspace. For example, if you are within Workspace 1 and created codes Code 1 and Code 2, those two codes would be considered unmanaged if you were looking at the same device in Workspace 2. Therefore, unmanaged codes include both codes not managed by Seam at all, and codes that might be managed by a different workspace within Seam.

Viewing Unmanaged Codes on a Device

You can retrieve a list of all unmanaged access codes for a particular device using the List Unmanaged Access Codes request, passing in device_id as a query parameter. For example:

Python

Request:

seam.access_codes.unmanaged.list(
  device_id="11111111-1111-1111-1111-444444444444"
)

Response:

[
  UnmanagedAccessCode(
    access_code_id='11111111-1111-1111-1111-999999999999',
    device_id='11111111-1111-1111-1111-444444444444',
    is_managed=False,
    ...
  ),
  ...
]

cURL (bash)

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/unmanaged/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "device_id": "11111111-1111-1111-1111-444444444444"
}'

Response:

{
  "access_codes": [
    {
      "access_code_id": "11111111-1111-1111-1111-999999999999",
      "device_id": "11111111-1111-1111-1111-444444444444",
      "is_managed": false,
      ...
    },
    ...
  ],
  "ok": true
}

JavaScript

Request:

await seam.accessCodes.unmanaged.list({
  device_id: "11111111-1111-1111-1111-444444444444"
})

Response:

[
  {
    access_code_id: '11111111-1111-1111-1111-999999999999',
    device_id: '11111111-1111-1111-1111-444444444444',
    is_managed: false,
    ...
  },
  ...
]

Ruby

Request:

client.unmanaged_access_codes.list(
  device_id: "11111111-1111-1111-1111-444444444444"
)

Response:

[
  <Seam::AccessCode:0x00438
    access_code_id="11111111-1111-1111-1111-999999999999"
    device_id="11111111-1111-1111-1111-444444444444"
    is_managed=false
    ...
  >
  ...
]

C#

Request:

seam.UnmanagedAccessCodes.List(
  deviceId: "11111111-1111-1111-1111-444444444444"
);

Response:

{
  "access_code_id": "11111111-1111-1111-1111-999999999999",
  "device_id": "11111111-1111-1111-1111-444444444444",
  "is_managed": false,
  ...
}
...

Java

Request:

seam.accessCodes().unmanaged().list(UnmanagedListRequest.builder()
        .deviceId("11111111-1111-1111-1111-444444444444")
        .build());

Response:

[
  {
    "access_code_id" : "11111111-1111-1111-1111-999999999999",
    "device_id" : "11111111-1111-1111-1111-444444444444",
    "is_managed" : "false",
    ...
  },
  ...
]

Converting Unmanaged Codes into Managed Codes

You can convert unmanaged access codes into managed ones using the Convert an Unmanaged Access Code request, passing in access_code_id as a query parameter. For example:

Python

Request:

seam.access_codes.unmanaged.convert_to_managed(
  access_code_id = "11111111-1111-1111-1111-999999999999"
)

Response:

ActionAttempt(action_attempt_id='721b51b7-6ab9-41cf-b09d-a5e97d355208',
              action_type='CONVERT_ACCESS_CODE_TO_MANAGED',
              status='success',
              result={},
              error=None)

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/unmanaged/convert_to_managed' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-999999999999"
}

Response:

{
  "action_attempt": {
    "status": "pending",
    "action_type": "CONVERT_ACCESS_CODE_TO_MANAGED",
    "action_attempt_id": "721b51b7-6ab9-41cf-b09d-a5e97d355208",
    "result": null,
    "error": null
  },
  "ok": true
}

JavaScript

Request:

await seam.accessCodes.unmanaged.convertToManaged({
  access_code_id: "11111111-1111-1111-1111-999999999999"
})

Response:

{
  actionAttempt: {
    status: 'success',
    action_attempt_id: '721b51b7-6ab9-41cf-b09d-a5e97d355208',
    action_type: 'CONVERT_ACCESS_CODE_TO_MANAGED',
    result: {},
    error: null
  }
}

Ruby

Request:

client.unmanaged_access_codes.convert_to_managed(
  access_code_id: "11111111-1111-1111-1111-999999999999"
)

Response:

<Seam::ActionAttempt:0x00438
  status="success"
  action_type="CONVERT_ACCESS_CODE_TO_MANAGED"
  action_attempt_id="721b51b7-6ab9-41cf-b09d-a5e97d355208"
  result=nil>

C#

Request:

seam.UnmanagedAccessCodes.ConvertToManaged(
  accessCodeId: "11111111-1111-1111-1111-999999999999"
);

Response:

Status: success
ActionType: CONVERT_ACCESS_CODE_TO_MANAGED
ActionAttemptId: 721b51b7-6ab9-41cf-b09d-a5e97d355208
Result:
Error:

Java

Request:

seam.accessCodes().unmanaged().convertToManaged(UnmanagedConvertToManagedRequest.builder()
        .accessCodeId("11111111-1111-1111-1111-999999999999")
        .build());

Response:

{
  "ok" : true
}

The request returns immediately, but the conversion is an asynchronous process that completes in the background. You can listen to the access_code.unmanaged.converted_to_managed and access_code.unmanaged.failed_to_convert_to_managed to be notified when conversion succeeds or fails.

Once an unmanaged code is successfully converted to a managed code, all of the normal managed access code operations and behavior are available.

Unsupported Conversion

Some third-party device providers strictly limit the information available about existing access codes on a device. Thus, for devices connected using these providers, we cannot convert unmanaged codes to managed ones. The following providers currently do not support conversion:

• igloohome

• Kwikset

• SmartThings

For SmartThings devices, you can still see a list of all unmanaged codes on the devices using the GET /access_codes/unmanaged/list endpoint, but you cannot see the actual PIN code for the access codes (the code property is not present).

Deleting Unmanaged Codes

After you have converted unmanaged codes to managed codes, or replaced them with new ones, you can allow users to delete any remaining unmanaged codes on their device. You can do this by using the Delete an Unmanaged Access Code request and passing in passing in access_code_id as a query parameter. For example:

Python

Request:

seam.access_codes.unmanaged.delete(
  access_code_id = "11111111-1111-1111-1111-999999999999"
)

Response:

ActionAttempt(action_attempt_id='364e747f-9631-4eb1-bc9e-24cd1f11cf3b',
              action_type='DELETE_UNMANAGED_ACCESS_CODE',
              status='success',
              result={},
              error=None)

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/unmanaged/delete' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-999999999999"
}'

Response:

{
  "action_attempt": {
    "status": "pending",
    "action_type": "DELETE_UNMANAGED_ACCESS_CODE",
    "action_attempt_id": "364e747f-9631-4eb1-bc9e-24cd1f11cf3b",
    "result": null,
    "error": null
  },
  "ok": true
}

JavaScript

Request:

await seam.accessCodes.unmanaged.delete({
  access_code_id: "11111111-1111-1111-1111-999999999999"
});

Response:

{
  actionAttempt: {
    status: 'success',
    action_attempt_id: '364e747f-9631-4eb1-bc9e-24cd1f11cf3b',
    action_type: 'DELETE_UNMANAGED_ACCESS_CODE',
    result: {},
    error: null
  }
}

Ruby

Request:

client.unmanaged_access_codes.delete(
  access_code_id: "11111111-1111-1111-1111-999999999999"
)

Response:

<Seam::ActionAttempt:0x00438
  status="success"
  action_type="DELETE_UNMANAGED_ACCESS_CODE"
  action_attempt_id="364e747f-9631-4eb1-bc9e-24cd1f11cf3b"
  result={}>

C#

Request:

seam.UnmanagedAccessCodes.Delete(
  accessCodeId: "11111111-1111-1111-1111-999999999999"
);

Response:

Status: success
ActionType: DELETE_UNMANAGED_ACCESS_CODE
ActionAttemptId: 364e747f-9631-4eb1-bc9e-24cd1f11cf3b
Result:
Error:

Java

Request:

seam.accessCodes().unmanaged()
  .delete(UnmanagedDeleteRequest.builder()
    .accessCodeId("11111111-1111-1111-1111-999999999999")
    .build());

Response:

{
  "ok" : true
}

The request returns an action attempt, similar to the managed code deletion endpoint. See Delete an access code for more details.