No Results
Get Secured Variable by User & Variable
Article Contents

EdgeCore version: 4.3.0

Method

GET /public/users/{userName}/secvars/{secVarName}

Used to retrieve a particular secured variable 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.

 
secVarName
 string Securable variable name Yes


cURL example

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

Example Response

{
    "userId": "9uvkg2-h266vjk3v3fb",
    "userName": "jane",
    "domainId": "9uvkg2-h266vjk3uc90",
    "doClass": "UserSecVarValueDO",
    "id": "bnc7r3-k9rmpkhprmgk",
    "varName": "CompanyName",
    "value": {
        "doClass": "SpStringValueDO",
        "isParameter": false,
        "primitiveValue": "Edge"
    },
    "inheritedValue": null,
    "inheritedValueScope": null
}

HTTP Response

Code Status Description
200 OK The request has succeeded.

Additionally, if {} is returned in the response, that means no secured variables have been set.
404 Not Found The secured variable could not be found.

Or

The user could not be found.
Terms | Privacy
×