Program

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, core	(Read-only) The program's identifier.
name	string, core	The program name.
website	string	The URL of the program website.
icon	string, core	The program logo or icon.
shortDescription	string	(Optional) A short description of program, shown in the card.
longDescription	string	(Optional) A long description of program, shown on details page.
status	string, core	The status of the program. Allowed values are: None Draft Published Unpublished Deleted
eligibility	string, core	Represents an object for storing information for the clients and reseller flags.
applicableTo	string, core	Allowed values are buyer or licensee.
products	object, core	Represents the product object, containing 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	object	Represents the vendor account object. Example: { "id": "ACC-1234-1234", "type": "Vendor", "status": "Enabled", "name": "Microsoft" }
settings	object	Represents the programSettings object. Example: "settings": { "newCertificateAutoapprove": true, "programEnrollment": false, "programLink": false, "terminateOnExpiration": { "enabled": true, "duration": 30 }, "preValidation": { "enrollmentDraft": false, "enrollmentQuerying": false, "reEnrollment": false } }
statistics	object	(Read-only) Represents the programStatistics object. Example: { "certificates": 110 }
audit	object	(Read-only) Represents the audit object.

Program Settings object

This object contains the following attributes:

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

Program Statistics object

This object contains the following attributes:

Field	Type	Description
certificates	integer	(Read-only) Total number of verified certificates.

Example

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,
  }
}