Example requests

Find field descriptions and example request payloads here.

Tenant provisioning

Below you will find descriptions of Enums and ID specific fields, the list of required fields, and two example payloads. These cover common use cases for provisioning tenants.

The payload should be included as the request body in a POST to https://api-admin.cylance.com/public/v2/{region}/tenants/provision.

Field Descriptions

  • name : “string”,
  • country : “string”,
  • zipCode : “string”,
  • address1 : “string”,
  • address2 : “string”,
  • city : “string”,
  • protectLicensesAllocated : “string”,
    • Must be 0 or non-negative number
  • phones : [ “string” ],
  • licenseType : “enum”,
    • Available values are Evaluation, Customer
  • opticsLicensesAllocated : “string”,
    • Must be 0 or non-negative number
  • term : “enum”,
    • Available values are Monthly, Annual
  • state : “string”,
  • email : “string”,
  • expirationDate : “dateTime”,
  • featureIds : [ 0 ] Available features and IDs listed below. Int value must be passed in array
    • "Linux" = 12,
    • "Device Control" = 26,
    • "Auto-Delete for Quarantined Files" = 32,
    • "Data Privacy" = 33,
    • "Optics V2" = 34,
    • "API V2" = 39,
    • "Read Only User Role" = 40,
    • "Script Control Global Safelist by Hash" = 42,
    • "Ubuntu" = 48, (Can only be enabled when “Linux” is enabled)
    • "Notification for Quarantine Events" = 49,
    • "Optics ML" = 51, (Can only be enabled when “Optics V2” is enabled)
    • "Optics Refract Package" = 53, (Can only be enabled when “Optics V2” is enabled)
    • "Optics Refract Playbook" = 56, (Can only be enabled when “Optics V2” is enabled)
    • "Amazon Linux" = 57 (Can only be enabled when “Linux” is enabled)

Required Fields

  • name
  • address1
  • city
  • state
  • country
  • zipCode
  • term
  • protectLicensesAllocated
  • opticsLicensesAllocated
  • licenseType

Example Request with Only Aurora Protect

JSON 
{
"Name": "Tenant Provision Only Protect",
"Email": "user.name@server.com",
"Address1": "123 Main St",
"Address2": "Suite 1",
"City": "Irvine",
"State": "CA",
"Country": "US",
"ZipCode": "92519",
"Term": "Monthly",
"ProtectLicensesAllocated": "100",
"OpticsLicensesAllocated": "0",
"LicenseType": "Evaluation",
"FeatureIds": [ 39, 33, 49, 40, 12, 42, 26, 32]
}

This is an example of a tenant with all features enabled except those related to Aurora Focus (formerly Optics), with 0 optics licenses allocated. This is a typical example of creating a tenant that only has Aurora Protect enabled.

Example Request with Aurora Protect and Aurora Focus

JSON 
{
"Name": "Tenant Provision Protect and Optics",
"Email": "user.name@server.com",
"Address1": "123 Main St",
"Address2": "Suite 1",
"City": "Irvine",
"State": "CA",
"Country": "US",
"ZipCode": "92519",
"Term": "Monthly",
"ProtectLicensesAllocated": "100",
"OpticsLicensesAllocated": "100",
"LicenseType": "Evaluation",
"FeatureIds": [ 39, 33, 49, 40, 12, 42, 26, 32, 34, 53]
}

This is an example of a creating a tenant where every endpoint is licensed for both Aurora Protect and Aurora Focus (formerly Optics). The features here include all those for Aurora Protect, plus Aurora Focus and Refract, which are flag numbers 34 and 53 respectively.