Gets the list of all credentials saved in the product.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
curl
curl -X POST \ https://<Director_IP_address>/c/router \ -H "cache-control: no-cache" \ -H "content-type: application/json" \ -b @cookies.txt \ -d "{ "action": "CredentialManagement", "method": "list", "data": [{"filter": { "start": 0, "count": 200, "sort: "USERNAME", "sortAsc": true, "criteria": [{ "type": "OR", "criteria": [{ "name": "USERNAME", "type": "ILIKE", "value": "aaa"}] }] } }], "type": "rpc", "tid": 1}"
Request Fields
Field | Type | Value(s) |
---|---|---|
action | string |
|
method | string |
|
data | Json | Filter parameters. See the |
type | string |
|
tid | integer |
|
filter
Field | Value | Description |
---|---|---|
| integer | A start ID of the tenant to be returned |
| integer | Number of tenants to be returned |
| string | Credential parameter to be sorted with |
| boolean |
|
| array | Filter criteria. See the rows below |
type | string | Type of criterion |
| string | Name of criterion. |
| string | Type of the criterion. |
| string | Value of the criterion |
Response Sample
{ "action": "CredentialManagement", "method": "list", "tid": "1", "type": "rpc", "message": null, "where": null, "cause": null, "data": [ { "id": 1, "type": "PASSWORD", "username": "administrator", "password": "$FAKE_PASSWORD$", "privateKey": null, "privateKeyFileName": null, "keyPassword": null, "description": "" } ] }
Response Fields
Field | Value | Description |
---|---|---|
message | string | Message if the request failed |
where | string | Reference to the method where the problem occurred |
cause | string | Cause of failure |
data | array | Credentials info |
data
Field | Value | Description |
---|---|---|
| int | Credentials ID |
type | string | Type of credentials. Possible values: PASSWORD or PRIVATE_KEY |
username | string | Username |
password | string | Password (obfuscated) |
privateKey | string | Private key |
privateKeyFileName | string | Private key filename |
keyPassword | string | Private key password (obfuscated) |
description | string | Description |