Set the access settings to products
PUT /api/2.0/settings/security/access
Request
Sets the access settings to the products with the IDs specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key
.
Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
,text/json
,text/plain
.- Content-Type
enum of string
Can be one of:
application/json
,application/*+json
,text/json
.
Body
Module request parameters
- items
array of object
Products with security information
- key
string
- value
boolean
Examples
PUT /api/2.0/settings/security/access HTTP/1.1
Accept: application/json
Content-Length: 107
Content-Type: application/json
Host: example.com
{
"items": [
{
"value": {
"key": "some text",
"value": true
}
}
]
}
curl --request PUT \
--url https://example.com/api/2.0/settings/security/access \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"items": [
{
"value": {
"key": "some text",
"value": true
}
}
]
}'
Responses
200
Security settings
- webItemId
string
Module ID
- users
array of object
List of users with the access to the module
- id
string
uuid ID
- displayName
string
Display name
- title
string
Title
- avatar
string
Avatar
- avatarOriginal
string
Original size avatar
- avatarMax
string
Maximum size avatar
- avatarMedium
string
Medium size avatar
- avatarSmall
string
Small avatar
- profileUrl
string
Profile URL
- hasAvatar
boolean
Specifies if the user has an avatar or not
- isAnonim
boolean
Specifies if the user is an anonim or not
- groups
array of object
List of groups with the access to the module
- id
string
uuid ID
- name
string
Name
- manager
string
Manager
- enabled
boolean
Specifies if the security settings are enabled or not
- isSubItem
boolean
Specifies if this module is a subitem or not
401
Unauthorized
403
Security settings are disabled for an open portal