Devices

Path:/directory/v3/devices

The devices endpoint provides management of Directory User Device linking and un-linking.

POST

Begin the process of linking a Device to a Directory User

Request

Requests will be a JWE encrypted JSON payload with the following attribute:

identifier (string):Directory User Identifier of the Directory User for which you wish to link a Device

Example:

{"identifier": "my-unique-user-identifier"}

Response

Responses will be a JWE encrypted JSON payload consisting of an array of Devices with the following attributes:

code (string):A unique linking code to provide the user to allow for manual entry when liking a device
qrcode (string):URL to the image of a QR Code image which represents the provided linking code

Example:

    {
        "code": "abcefgh",
        "qrcode": "https://api.launchkey.com/public/v3/qr/abcefgh",
    }
]

DELETE

Unlink, or delete, a single Device for a Directory User

Request

Requests will be a JWE encrypted JSON payload with the following attribute:

identifier (string):Directory User Identifier of the Directory User for which you wish to retrieve a list of Devices
device_id (string):Device ID of the User's Device you wish to unlink

Example:

{"identifier": "my-unique-user-identifier", "device_id": "5d1acf5c-dc5d-11e7-9ea1-0469f8dc10a5"}

Response

There is no response data.

User Contributed

LaunchKey links to user contributed code as a resource to its community. LaunchKey does not in any way guarantee or warrant the quality and security of these code bases. User contributed code is supported by the creators. If you do find a link from the site to user contributed code that is malicious or inappropriate in any way, please report that link to LaunchKey immediately and we will investigate the claim. Submit any issue to LaunchKey support at https://launchkey.com./support. ×