Credentials

Credentials consist of a user name and password pair. They are used to access specified target machines in order to perform scans and push any necessary files. You can define new scan credentials, locate existing credentials, share credentials, and delete credentials.

Operations invoked by the REST API run as the Windows System account, which cannot decrypt credentials that are not shared with it. To facilitate this ability, you must provide session credentials for the specified user, as described in Session Credentials.

You can find and view service credentials, which are credentials available to all administrators and are used to access service components within Security Controls. A service credential is created whenever you enable the Enable for background services check box on the Share Credential dialog within Security Controls.

Base URLs

        https://<consoleFQDN:port>/st/console/api/v1.0/credentials
        https://<consoleFQDN:port>/st/console/api/v1.0/servicecredentials

Servicecredentials requests will be deprecated in a future release.

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}

 

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}/share

Share Body Success code

GET

https://<consoleFQDN:port>/st/console/api/v1.0/credentials

URL Parameters

User credential list

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}

 

UserCredential

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}/share

 

User name list

https://<consoleFQDN:port>/st/console/api/v1.0/servicecredentials

 

ServiceCredential

https://<consoleFQDN:port>/st/console/api/v1.0/servicecredentials/{servicecredential id}

 

ServiceCredential

POST

https://<consoleFQDN:port>/st/console/api/v1.0/credentials

Credentials Body

UserCredential

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}/share

Only users who have previously logged on to the Security Controls console machine are eligible to be assigned a shared credential.

Share Body UserCredential

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}

Credentials Body

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/credentials/{credential id}/share

Only users who have previously logged on to the Security Controls console machine are eligible to be assigned a shared credential.

Share Body Success code

Input Models

Example with Sample Response

Find all credentials created by the current user

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/credentials

Sample Response

Copy
{
    "count": 1,
    "value": [
        {
            "id": "01234567-89AB-CDEF-0123-456789ABCDEF",
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/credentials/01234567-89AB-CDEF-0123-456789ABCDEF"
                },
                "sharewithservice": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/credentials/01234567-89AB-CDEF-0123-456789ABCDEF/sharewithservice"
                },
                "share": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/credentials/01234567-89AB-CDEF-0123-456789ABCDEF/share"
                }
                "servicecredential": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/servicecredentials/87654321-89AB-CDEF-0123-987654ABCDEF"
                }
            },
            "name": "JoesCreds",
            "ownerName": "Sample\\Administrator",
            "sharedWith": [
                "Sample\\win1",
                "Sample\\Administrator",
                "NT AUTHORITY\\SYSTEM"
                ],
            "sharedWithService": true,
            "userName": "joe.coder"
        }
    ]
}

Other Request Examples

Output Models