Difference between revisions of "RegisterTrustedDeviceChallenge"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Register a new device in the Trusted Device list. To use this method, the user should be logged. Returns a TrustedDeviceChallenge. |Parameters=...") |
m |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Register a new device in the Trusted Device list. | + | Description=Register a new device in the Trusted Device list. |
| − | + | Returns a [[TrustedDeviceChallenge]]. | |
| + | |||
| + | Returns a challenge code for pairing a a new or not-yet-enabled trusted device to the user account. | ||
| + | |||
| + | NOTE: The difference between this method and RegisterTrustedDeviceChallenge is that GetTrustedDeviceChallengeCode creates a challenge code for pairing to a trusted device that already exists. RegisterTrustedDeviceChallenge creates a challenge code for a device that is not associated to the user account yet. | ||
|Parameters= | |Parameters= | ||
| Line 57: | Line 61: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing a TrustedDeviceChallenge. | + | Returns a JSON object containing a [[TrustedDeviceChallenge]]. |
'''Example:''' | '''Example:''' | ||
| Line 66: | Line 70: | ||
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
: <span style="color: #a11;">"Content"</span>: | : <span style="color: #a11;">"Content"</span>: | ||
| − | :: { <span style="color: #219;">Object TrustedDeviceChallenge</span> } | + | :: { <span style="color: #219;">Object [[TrustedDeviceChallenge]]</span> } |
} | } | ||
Latest revision as of 14:38, 10 June 2015
Description
Register a new device in the Trusted Device list. Returns a TrustedDeviceChallenge.
Returns a challenge code for pairing a a new or not-yet-enabled trusted device to the user account.
NOTE: The difference between this method and RegisterTrustedDeviceChallenge is that GetTrustedDeviceChallengeCode creates a challenge code for pairing to a trusted device that already exists. RegisterTrustedDeviceChallenge creates a challenge code for a device that is not associated to the user account yet.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- trustedDeviceTypeId (int, required)
- The device type id from the device that wants to register. This device typeID should be previously registered on the MiB Tools.
- trustedDeviceId (String, required)
- The string that represent some unique information from device and could be used to register a unique id for the instance.
- friendlyName (String, required)
- A text to identify the device by a friendly name on the list.
- deviceModel (String, optional)
- deviceOperatingSystem (String, optional)
- macAddress (String, optional)
- clientVersion (String, optional)
Returns
Returns a JSON object containing a TrustedDeviceChallenge.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- { Object TrustedDeviceChallenge }
}
Exceptions
- None
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
