Page tree

Gets the list of all credentials saved in the product.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/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)
actionstring

CredentialManagement

methodstring

list

dataJson

Filter parameters. See the filter table below

typestring

rpc

tidinteger

1

filter

Field

Value

Description

start

integer

A start ID of the tenant to be returned

count

integer

Number of tenants to be returned

sort

string

Credential parameter to be sorted with

sortAsc

boolean

true if the order is ascending

criteria

array

Filter criteria. See the rows below

typestringType of criterion

name

string

Name of criterion. USERNAME means the user name

type

string

Type of the criterion. ILIKE means the case-sensitive LIKE operator

value

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
messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure
dataarrayCredentials info

data

Field
Value
Description

id

intCredentials ID
typestringType of credentials. Possible values: PASSWORD or PRIVATE_KEY
usernamestringUsername
passwordstringPassword (obfuscated)
privateKeystringPrivate key
privateKeyFileNamestringPrivate key filename
keyPasswordstringPrivate key password (obfuscated)
descriptionstringDescription


  • No labels