Set the module security settings

PUT /api/2.0/settings/security

Request

Sets the security settings to the module with the ID 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

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Module request parameters

idstring

Module ID

enabledboolean

Specifies if the module security settings are enabled or not

subjectsarray of string

List of user/group IDs with the access to the module

Examples

PUT /api/2.0/settings/security HTTP/1.1
Accept: application/json
Content-Length: 100
Content-Type: application/json
Host: example.com

{
  "id": "348",
  "enabled": true,
  "subjects": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}

curl --request PUT \
  --url https://example.com/api/2.0/settings/security \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "348",
  "enabled": true,
  "subjects": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}'

Responses

200

Security settings

webItemIdstring

Module ID

usersarray of object

List of users with the access to the module

idstringformat: uuid

ID

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

groupsarray of object

List of groups with the access to the module

idstringformat: uuid

ID

namestring

Name

managerstring

Manager

enabledboolean

Specifies if the security settings are enabled or not

isSubItemboolean

Specifies if this module is a subitem or not

401

Unauthorized

403

Security settings are disabled for an open portal