Properties REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
Properties
Provides properties for a given node.
Applicable to: All JCR nodes.
GET
Returns an object with properties.
Requires that the caller is authorized to READ the node.
The caller must also be authorized to MANAGE_USERS on the sv:site to get properties for any node of these types:
- sv:adminPrincipalRepository
- sv:directory
- sv:directoryRepository
- sv:externalPrincipalRepository
- sv:globalVirtualGroup
- sv:principalRepository
- sv:simpleUser
- sv:systemGroup
- sv:systemUser
- sv:user
- sv:userGroup
- sv:userContainer
- sv:virtualGroup
- sv:virtualGroupRepository
The caller must also be authorized to MANAGE_USERS or MANAGE_USER_IDENTITIES on the sv:site to get properties for a node of type:
- sv:userIdentity
| Name | Type | Description |
|---|---|---|
| properties | array |
An array of properties to return. If omitted all properties are returned |
Example input
{
"properties": ["displayName", "URL"]
}
PUT
Updates properties for a sv:simpleUser node.
Note! Only applicable to: sv:simpleUser of the sv:externalPrincipalRepository.
Requires that the caller is the sv:simpleUser or is authorized to MANAGE_USERS on the sv:site.
| Name | Type | Description |
|---|---|---|
| properties | object |
An object of properties with a value |
Example URL
255.6cc338af1604bfd297cb429_6d616e6765/properties
Example input
{
"properties": {
"name": "Boba Fett",
"givenName": "Boba",
"sn": "Fett",
"title": "Hunter",
"mail": "boba@fett.com"
}
}
Authentication properties
A sv:simpleUser can be a "web user" that has local authentication credentials. Such authentication data/settings can be set as properties using the reserved names described below. Note that the request must be secure (https) in order for them to actually be set!
| Property name | Type | Description | Since |
|---|---|---|---|
| useLocalAuthentication | boolean |
Whether or not to allow local authentication | 4.5.2 |
| localAuthenticationPassword | string |
The local authentication password | 4.5.2 |