Getting Credentials

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

Copy

curl -X POST \
    -- url https://<Director_IP_address>/c/router \
    -- "cache-control: no-cache" \
    -- "content-type: application/json" \
    -- @cookies.txt \
    -- data"{
        "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	`CredentialManagement`
`method`	string	`list`
`data`	Json	Filter parameters. See the `filter` table below
`type`	string	`rpc`
`tid`	integer	`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
`type`	string	Type 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

curl

Copy

 {
    "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
`id`	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