No Results
Get Credential by User & Name

EdgeCore version: 4.3.0

Method

GET /public/users/{userName}/credentials/{credentialName}

Used to retrieve a particular credential by its name and by a specific user.

Parameters

Name Type Description Mandatory
userName
string Username of the user Yes

If domain name is not included (userName@domainName), it assumes the default domain.

credentialName
string Credential name Yes

 

cURL example

curl --location --request GET 'http://localhost:8080/public/users/jane/credentials/TestCred' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' 

Example Response

{
    "userId": "9uvkg2-h266vjk3v3fb",
    "userName": "jane",
    "domainId": "9uvkg2-h266vjk3uc90",
    "doClass": "UserSecVarValueDO",
    "id": "bnc7r3-k9rmpkhprpga",
    "varName": "TestCred",
    "value": {
        "doClass": "CredentialSetDO",
        "isParameter": false,
        "credentials": [
            {
                "doClass": "CredentialPairDO",
                "key": "Username",
                "value": {
                    "doClass": "SpStringValueDO",
                    "isParameter": false,
                    "primitiveValue": "bestuser"
                },
                "hidden": false,
                "required": false
            },
            {
                "doClass": "CredentialPairDO",
                "key": "Password",
                "value": {
                    "doClass": "SpEncryptedStringValueDO",
                    "isParameter": false,
                    "plainValue": "UNUSED",
                    "encryptedValue": "#default!Xtb5VSKgiOVloPU7gxl+Kt3DmfzsdaJ0tnrzOq6PNiE="
                },
                "hidden": true,
                "required": false
            }
        ]
    },
    "inheritedValue": null,
    "inheritedValueScope": null
}

HTTP Response

Code Status Description
200 OK The request has succeeded.
404 Not Found The credential could not be found.

Or

The user could not be found.


Terms | Privacy