Devices List

Path:/directory/v3/devices/list

This endpoint provides the ability to get a list of devices for a particular Directory User. It exists so that the Directory User ID need not be exposed via the URL in what would normally be a GET request.

POST

Retrieves a Device list for a Directory User.

Request

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

identifier (string):The Directory User ID of the Directory User in order to retrieve a list of Devices.

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:

id (string):

The globally unique identifier for the device.

name (string):

The name of the device.

type (string):

A descriptive name for the type of device.

status (number):

An Integer representing the current status of the device. It will be one of the following:

  • 0: Link process initiated by the Directory but the Device has not yet completed. The Device is

    NOT ready to answer authorization requests.

  • 1: Link process completed by the Device. The Device is ready to answer authorization requests.

created (string):

An ISO-8601 formatted date signifying the time when the device was created.

updated (string):

An ISO-8601 formatted date signifying the time when the last update to the device was performed.

Example of User with Devices:

[
    {
        "id": "5d1acf5c-dc5d-11e7-9ea1-0469f8dc10a5",
        "name": "My Android Device",
        "type": "Android",
        "status": 0,
        "created": "2017-01-01T01:01:01Z",
        "updated": "2017-01-01T01:01:01Z"
    },
    {
        "id": "b001ff59-dc5d-11e7-8927-0469f8dc10a5",
        "name": "My Apple Device",
        "type": "iOS",
        "status": 1,
        "created": "2017-03-03T03:03:03Z",
        "updated": "2017-03-03T03:03:13Z"
    }
]

Example of User with no Devices:

[]

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. ×