Skip to content

Create a new Enterprise Policy
Stable

Request

API to create a new Enterprise Policy

Security
apiKey
Path
enterprise_idstring, (uuid)required

ID of the enterprise

Body*/*required

The request body to create an Enteprise Policy

enterprisestring, (url)(Enterprise url)required

Url of the enterprise resource

namestring(Policy Name)required

Name of the Policy

descriptionstring(Policy Description)

Details regarding the Policy

policyobject(Policy Data)required
is_activeboolean(Policy Active status)

Is this policy currently active

cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/enterprise/{enterprise_id}/policy/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: */*' \
  -d '{
    "enterprise": "string",
    "name": "string",
    "description": "string",
    "policy": {
      "keyguardDisabled": true,
      "safeBootDisabled": true,
      "statusBarDisabled": true,
      "factoryResetDisabled": true,
      "screenshotDisabled": true,
      "usbConnectivityDisabled": true,
      "smsDisabled": true,
      "outgoingCallsDisabled": true,
      "cameraDisabled": true,
      "nfcBeamDisabled": true,
      "disablePlayStore": true,
      "usbFileTransferDisabled": true,
      "tetheringDisabled": true,
      "dateTimeConfigDisabled": true,
      "appUninstallDisabled": true,
      "googleAssistantDisabled": true,
      "disableLocalAppInstall": true,
      "adbDisabled": true,
      "phonePolicy": {
        "incomingNumbers": [
          "string"
        ],
        "outgoingNumbers": [
          "string"
        ],
        "dialer": "DEFAULT",
        "allowUssdCodes": false
      },
      "frpGoogles": [
        {
          "type": "USER",
          "email": "user@example.com",
          "googleId": "string"
        }
      ],
      "googleAccountPermission": {
        "maxAccount": 0,
        "emails": [
          "user@example.com"
        ],
        "domains": [
          "string"
        ]
      },
      "devicePasswordPolicy": {
        "passwordQuality": "PASSWORD_QUALITY_ALPHABETIC"
      },
      "minimumPasswordLength": 4,
      "permissionPolicy": "PERMISSION_POLICY_PROMPT",
      "deviceUpdatePolicy": {
        "type": "TYPE_INSTALL_AUTOMATIC",
        "maintenanceStart": 0,
        "maintenanceEnd": 0
      },
      "settingsAccessLevel": "SYSTEM",
      "settingsAppPassword": "pa$$word"
    },
    "is_active": true
  }'

Responses

command request successfully created

Bodyapplication/json
uuidstring, (uuid)(UUID)read-only

Unique Policy identifier

enterprisestring, (url)(Enterprise url)required

Url of the enterprise resource

urlstring, (url)(Policy URL)read-only

URL link to policy

namestring(Policy Name)required

Name of the Policy

descriptionstring(Policy Description)

Details regarding the Policy

device_countinteger(Number of Devices with this policy applied)read-only

Count of Devices with this policy applied

google_policy_idstring(Google policy id)read-only

Id of the Google policy

policyobject(Policy Data)required
updated_onstring, (date-time)(Updated On)read-only

Last-Updated Timestamp of Policy

created_onstring, (date-time)(Created on)read-only

Creation Timestamp of Policy

is_activeboolean(Policy Active status)

Is this policy currently active

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "enterprise": "string",
  "url": "string",
  "name": "string",
  "description": "string",
  "device_count": 0,
  "google_policy_id": "string",
  "policy": {
    "keyguardDisabled": true,
    "safeBootDisabled": true,
    "statusBarDisabled": true,
    "factoryResetDisabled": true,
    "screenshotDisabled": true,
    "usbConnectivityDisabled": true,
    "smsDisabled": true,
    "outgoingCallsDisabled": true,
    "cameraDisabled": true,
    "nfcBeamDisabled": true,
    "disablePlayStore": true,
    "usbFileTransferDisabled": true,
    "tetheringDisabled": true,
    "dateTimeConfigDisabled": true,
    "appUninstallDisabled": true,
    "googleAssistantDisabled": true,
    "disableLocalAppInstall": true,
    "adbDisabled": true,
    "phonePolicy": { … },
    "frpGoogles": [ … ],
    "googleAccountPermission": { … },
    "devicePasswordPolicy": { … },
    "minimumPasswordLength": 4,
    "permissionPolicy": "PERMISSION_POLICY_PROMPT",
    "deviceUpdatePolicy": { … },
    "settingsAccessLevel": "SYSTEM",
    "settingsAppPassword": "pa$$word"
  },
  "updated_on": "2019-08-24T14:15:22Z",
  "created_on": "2019-08-24T14:15:22Z",
  "is_active": true
}