Edge Technologies, Inc. | Documentation | Set Secured Variable for User

EdgeCore version: 4.3.0

Method

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

Used to set a particular secured variable for a specific user.

Note that the secured variable in question first needs to be configured on the Provision Defaults page.

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	Secured variable name you want to set for the user	Yes
inherited	boolean	Specifies whether the secured variable inherits the default value. If true, the secured variable value is reset to inherit the default value.	No
value	string	Secured variable value If value is not set, the secured variable value is reset to inherit the default value.	No
isExpression	boolean	Specifies whether the secured variable will be evaluated as an expression If true, the variable string will be evaluated as an expression (e.g. info.login.username).	No

cURL example

curl --location --request PUT 'http://localhost:8080/public/users/jane/secvars/CompanyName' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \
--form 'inherited=false' \
--form 'value=Edge' \
--form 'isExpression=false'

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

The request has succeeded.

404

Not Found

The secured variable could not be found.

The user could not be found.