LaunchKey Device Management

If you have a directory in your organization, you may manage user devices with this endpoint.

Authorization

These endpoints uses V3 API Authorization and V3 API Encryption for both the request and response. It will use credentials for the Organization to which the directory belongs. The issuer category will be organization and the key will be the Organization Key for the directory's parent Organization. The Private Key used to sign the JWT will also belong to the Organization.

Get A List of Devices

Request

Method:POST
Path:/organization/v3/whitelabel/user/devices/list
Content Type:application/jwe
Accept Types:application/jwe

Body

JWE Compact Serialized data containing the encrypted request data which itself is a JSON string representing a list of device entries containing the following attributes:

sdk_key:SDK Key for the directory. This can be located in the Keys section of the directory's page.
device_type:Permanent and unique identifier of this user within the directory.

Example

{"sdk_key": "WLA9FG2YRXX98UAMB3X430DXOZXCSV5D", "identifer": "326335b0-8569-4aa3-90a3-ac4372104ea3"}

Response

Status:200 OK
Content-Type:application/jwe

Body

JWE Compact Serialized data containing the encrypted request data which itself is a JSON string representing a list of device entries containing the following attributes:

name:The device name. Device names are unique to the user.
device_type:Type of device: IOS, Android, Windows, etc.
status:The current status of the device: 0-2 (0: Pending link confirm, 1: Active, 2: Pending unlink confirm)
created:ISO 8601 compliant date/time the device was created
updated:ISO 8601 compliant date/time the device was last updated

JSON Example

[
  {"name": "First Device", "device_type": "IOS", "status": 1, "created": "2015-01-01T12:30:15Z", "update":  "2015-01-01T12:45:15Z"},
  {"name": "Second Device", "device_type": "Android", "status": 0, "created": "2015-02-11T16:30:15Z", "update":  "2015-02-11T16:45:15Z"}
]

Response

Status:201 Created
Content-Type:application/jwe

Body

JWE Compact Serialized data containing the encrypted request data which itself is a JSON string representing a list of device entries containing the following attributes:

code:The linking code the device will use to complete the linking process.
qr_code:A URL to a QR code version of the code.

JSON Example

{"code": "5r53j9z", "qrcode": "https://api.onprem.com/qrcode/5r53j9z"}

Response

Status:204 No Content
Content-Type:application/jwe

Body

There is no body returned in the response.

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