Extension

The Extension object represents a set of requirements (parameters) that vendors ask their clients to meet. Think of it as a checklist (extension parameters) that ensures clients are ready and able to work with the vendor’s products or services.

Field Name
Data Type
Description

id

string

The identifier for the extension.

Example: EXT-1234-5678

name

string

The name of the extension.

Example: Microsoft AI Cloud Partner

website

URI

The URL for the extension website.

Example: Microsoft AI Cloud Partner

icon

string

The logo of the extension.

Example: /v1/extension/extensions/EXT-1234-1234/icon

shortDescription

string

A short description of the extension.

Example: Microsoft 365 and Office 365 are cloud-based productivity suites

longDescription

string

A long description of the extension.

Example: Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently.

categories

object (category)

Contains a list of selected categories.

Example:

vendor

object

A reference to the vendor account object.

Example:

status

enum

The status of the extension. Possible values are

  • Draft

  • Deleted - Can be deleted if it's in a draft state.

  • Public - Available in the extensions directory. Only an Operations user can make the extension public.

  • Private - Not available in the extensions directory, but can be accessed through an invitation.

statistics

object

A reference to the extensionStatistics object.

Example:

configuration

object

Configuration object. Available only if retrieved with the extension’s token or vendor token.

Example:

service

object

service information.

Example:

meta

object

A reference to the extensionMeta object.

Example:

audit

object

A reference to the audit object.

Extension Statistics object

Field Name
Data Type
Description

installations

integer

The number of installations assigned to the extension.

Example: 100

Service object

Field Name
Data Type
Description

secret

string

Represents the secret key.

Example: ds340ffdjBfdj9834hfin4g

Example response

Last updated

Was this helpful?