Returns credential mappings

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns credential mappings for device control operations.

Request URL

https://{server-hostname}:8383/dcapi/device/credentialMappings

Scope

DeviceControl.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/device/credentialMappings \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'
Show full

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

- 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

Possible Response Codes

200HTTP code
500HTTP code

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.