Returns credential mappings

Returns credential mappings for device control operations.

Endpoint

get /dcapi/device/credentialMappings

Copy full URL

Request URL

https://{serverurl}/dcapi/device/credentialMappings Copied!

Scope

DesktopCentralCloud.DeviceControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/dcapi/device/credentialMappings \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/device/credentialMappings"))
        .header("Content-Type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Content-Type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/device/credentialMappings", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/device/credentialMappings"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/device/credentialMappings' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

credentialMappingsJSON Array

List of credential mappings grouped by domain/workgroup

Show Sub-Attributes

JSON Object

Show Sub-Attributes

namestring

Domain or workgroup name

credentiallistJSON Array

List of credentials for this domain/workgroup

Show Sub-Attributes

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

namestring

Domain or workgroup name

credentiallistJSON Array

List of credentials for this domain/workgroup

Show Sub-Attributes

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

JSON Object

Show Sub-Attributes

namestring

Domain or workgroup name

credentiallistJSON Array

List of credentials for this domain/workgroup

Show Sub-Attributes

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

namestring

Domain or workgroup name

credentiallistJSON Array

List of credentials for this domain/workgroup

Show Sub-Attributes

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

JSON Object

Show Sub-Attributes

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

credIDstring

Credential identifier

credUUIDstring

Credential UUID

credNamestring

Credential name

credTypestring

Credential type code

userNamestring

Username associated with the credential

credLabelstring

Display label for the credential

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodestring

Error code identifying the type of error

errorMsgstring

Human-readable error message

Sample Response: HTTP 200

Credential mappings response

Copied!

  {
    "credentialMappings": [
      {
        "name": "ZOHOCORP",
        "credentiallist": [
          {
            "credName": "DCP",
            "credUUID": "abc-def-123",
            "credType": "301",
            "credLabel": "DCP / admin",
            "credID": "1",
            "userName": "admin"
          }
        ]
      }
    ]
  }

▼ Show full

Sample Response: HTTP 500

Internal server error

Copied!

  {
    "errorCode": "INTERNAL_ERROR",
    "errorMsg": "Internal Server Error!"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.