Views:

Last Updated: 1/22/2020 12:10:59 AM

Update policies for customers.

1. If customers specified, it will only update their policies.

2. Otherwise, it will update for all your customers.

Request

HTTP Request

PUT /SMPI/{version}/service/wfbss/api/policies

Parameters

Name

Type

Description

Validation

Optional Parameters

cids

string

A list of customer IDs separated by comma.

At least one customer ID must be specified, and no more than 10. This field will become required, if sync is set true.

gids

String

A list of group IDs separated by comma.

os

String

OS type

Valid option: win, mac, android, or ios. If not set, the default value is win.

sync

boolean

Set whether to process the update synchronously.

If not set, the default is false. However, if set true, cids will become required.

HTTP Request Example

Asynchronously update policies for all your customers:
PUT /SMPI/{version}/service/wfbss/api/policies

Asynchronously update policies for specific customers:
PUT /SMPI/{version}/service/wfbss/api/policies?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Synchronously update policies for specific customers's groups:
PUT /SMPI/{version}/service/wfbss/api/policies?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3&gids=1,2&sync=true

Request Body

1. You only need to send the policy fields that you want to update:
{
  "policy": {
    "behavior_monitoring": {
      "enabled": 0
    }
  }
}

2. You can replicate policies from the other customer's group:
{
  "replicate_from": {
    "cid": "A9CC5A34-3CAD-480D-A9ED-87656316D3B9",
    "gid": 2    
  }
}

Name

Type

Description

Validation

Optional Parameters

replicate_from.cid

string

The customer company ID of the source of policies for replications.

GUID

replicate_from.gid

integer

The group ID of the source of policies for replications.

policy

object

For Windows, please refer to Windows' Policy page For Mac, please refer to Mac's Policy page For Android, please refer to Android's Policy page For iOS, please refer to iOS' Policy page

Response

HTTP Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

1. If parameter sync is set true, the response body is empty.

2. Otherwise, the reponse body is as below:
{
    "task": {
        "status": "PENDING",
        "id": "0e41dc95-eb78-4dd3-9c1f-3bc47b915ab4"
    }
}

Name

Type

Description

Length

task.id

string

The ID of the asynchronous task to update gobal settings.

GUID

task.status

string

The status of the asynchronous task to update gobal settings.

PENDING, STARTED, SUCCESS, FAILURE, or REVOKED
Parent topic: Policies