Programs

Program object

The Program object represents a set of requirements (parameters) that vendors ask their clients to meet. This object contains the following attributes:

Field	Type	Description
id	string	The program's identifier. Example: PRG-1234-5678
name	string	The name of the program. Example: Microsoft AI Cloud Partner
website	string	The URL for the program website. Example: https://www.microsoft.com
icon	string	The program logo's or icon.
status	string	The status of the program. The possible values are None, Draft, Published, Unpublished, or Deleted.
eligibility	string	Represents an object for storing information for the clients and reseller flags.
applicableTo	string	Possible values: Buyer or Licensee
products	product	Contains a list of selected products. Example: [ { "id": "PRD-1111-1111", "name": "Microsoft Office 365 NCE", "externalIds": {}, "icon": "/static/PRD-1111-1111-1111/logo.png", "status": "Published" } ]
vendor	account	A reference to the Vendor Account object. Example: { "id": "ACC-1234-1234", "type": "Vendor", "status": "Enabled", "name": "Microsoft" }
settings	programSettings	Example: "settings": { "newCertificateAutoapprove": true, "programEnrollment": false, "programLink": false, "terminateOnExpiration": { "enabled": true, "duration": 30 }, "preValidation": { "enrollmentDraft": false, "enrollmentQuerying": false, "reEnrollment": false } }
statistics	programStatistics	Example: { "certificates": 110 }
audit	audit	A reference to the Audit object.

Program Settings object

Field	Type	Description
newCertificateAutoapprove	boolean	Automatically activates every new certificate request for this program. Example: true
programEnrolment	boolean	Displays the Enrol button on the program profile, enabling the client to place a request for this program. Example: true
programLink	boolean	Displays the Info button on the program profile, enabling clients to go to a URL to get more information. Example: true
terminateOnExpiration		Terminates the certificate on the expiration date, if the certificates have an expiration date. Example: true
terminateOnExpiration.enabled	boolean	Sets whether the certificates expire. Example: true
terminateOnExpiration.duration	number	The duration in days. Example: 30
preValidation		Contains settings for the pre-validation phase during enrollment. Example: true
preValidation.enrollmentDraft	boolean	Validates change enrollment during the creation and before the enrollment is submitted. Example: false
preValidation.enrollmentQuerying	boolean	Validates querying enrollment during the creation and before the enrollment is submitted. Example: false
preValidation.reEnrollment	boolean	Validates before and during the re-enrollment. Example: false

Program Statistics object

Field	Type	Description
certificates	integer	The total number of verified certificates. Example: 1

Examples

PROGRAM OBJECT

{
  "id": "PRG-1234-5678",
  "name": "Microsoft AI Cloud Partner",
  "website": "https://www.microsoft.com",
  "icon": "/v1/program/programs/PRG-1234-1234/icon",
  "status": "Draft",
  "eligibility": {
    "client": true,
    "partner": true
  },
  "applicableTo": "Buyer",
  "products": [
      { 
          "id": "PRD-1111-1111", 
          "name": "Microsoft Office 365 NCE", 
          "externalIds": {},
          "icon": "/static/PRD-1111-1111-1111/logo.png",
          "status": "Published" 
      } 
  ],
  "vendor": {
      "id": "ACC-1234-1234",
      "type": "Vendor",
      "status": "Enabled",
      "name": "Microsoft"
  },
  "settings": {
      "newCertificateAutoapprove": true,
      "programEnrollment": false,
      "programLink": false,
      "terminateOnExpiration": {
          "enabled": true,
          "duration": 30
      },
      "preValidation": {
          "enrollmentDraft": false,
          "enrollmentQuerying": false,
          "reEnrollment": false
      }
  }, 
  "statistics": {
    "certificates": 100,
  }
}