Takeover action from Service Desk

Release Time

06/07/2018

Views

8780 times

Tags

No results found.

Description

An interface with which to generate the takeover link.

Scheme

https

Host

Valid ITSM host (example: subdomain-msp.cmdm.comodo.com )

Path
/api/rest/v1/web-rtc/remote-control – the actual path

/api/rest/v1/web-rtc/ccv – deprecated

Method	POST
Content-Type	JSON (application/json)

Request Headers

Key	Value	Description
x-auth-type	2	Authentication type identifier
x-auth-token	sso-token	Authentication SSO token

Request Parameters

Name	Type	Required	Description	Limitation
mdmTokens	JSON Array	required	Array of devices mdm-tokens	count - min 1, max 10
mdmTokens[]	String	required	Device mdm-token

Response Parameters

Name

Type

Required

Description

Limitation

status

Integer

required

Device status

Possible values are:

1 - device is online and not deleted
2 - device is offline
3 - device is deleted
4 - Device is not support Takeover
5 - Token out of scope
6 - Forbidden by Access Scope
7 - CRC disabled on portal

message

String

optional

CRC or CCV link for Windows XP/Server 2003

Meet when status = 1

See the below link for details:

Execution

Sample execution can be handled via Postman Application.

{
    "mdmTokens": [
        "some_token_0", // in this example: online and not deleted device
        "some_token_1", // in this example: offline device
        "some_token_2"  // in this example: deleted device
        "some_token_3"  // in this example: not supported device
        "some_token_4"  // token out of scope
    ]
}

 
{
    "mdmTokens": [
        "some_token_0", // in this example: online and not deleted device
        "some_token_1", // in this example: offline device
        "some_token_2"  // in this example: deleted device
        "some_token_3"  // in this example: not supported device
        "some_token_4"  // token out of scope
    ]
}

Header part can be handled via Postman Application

​

Success Output

{
    "some_token_0": {
        "status": 1,
        "message": "crc://some_token_0..."
    },
    "some_token_1": {
        "status": 2
    },
    "some_token_2": {
        "status": 3
    },
    "some_token_3": {
        "status": 4
    },
    "some_token_4": {
        "status": 5
    }
}

 
{
    "some_token_0": {
        "status": 1,
        "message": "crc://some_token_0..."
    },
    "some_token_1": {
        "status": 2
    },
    "some_token_2": {
        "status": 3
    },
    "some_token_3": {
        "status": 4
    },
    "some_token_4": {
        "status": 5
    }
}

Error Output

Code	Reason
200	    Ok.
400	    Bad request. Returns if mdmTokens is not provided or empty. Also you can get this error when required headers is missing
401	    Unauthorized. Returns if x-auth-token is not provided
403	    Forbidden. Returns if authentication failed

 
Code    Reason
   Ok.
   Bad request. Returns if mdmTokens is not provided or empty. Also you can get this error when required headers is missing
   Unauthorized. Returns if x-auth-token is not provided
   Forbidden. Returns if authentication failed