Skip to main content

Object Type JSON Reference

JSON Syntax for /ObjectType endpoints.

ObjectType​

{
  // ID for object type
  "id": "string",

  // Display name for object type
  "name": "string",

  // Display name property to use in governed object lists
  "displayNameProperty": #ConfigurationPropertyRef,

  // Properties to include in the unique master item key. Can be overriden by schema.
  "masterKeyProperties": [ #ConfigurationPropertyRef, ... ],

  // Configuration types to include in this object type.
  "configurationTypes": [ #ConfigurationType.id, ... ],

  // UI properties to customize the governed object table
  "uiProperties": #ObjectType.uiProperties
}

ConfigurationPropertyRef​

To reference a config type property, the syntax is:

#ConfigurationPropertyRef ::= #ConfigurationType.id + "." + #ConfigurationProperty.id

**Samples**
"AzureADUser.id"           (ConfigType = AzureADUser, Property = id)
"LicenseAssignment.user"   (ConfigType = LicenseAssignment, Property = user)

See Configuration Type

ObjectType.uiProperties​

{
  // Category for this object type, i.e. "AzureAD"
  "uiCategory": "string",

  // Table title to use when displaying as governed object table
  "uiTitle": "string",

  // Table subtitle to use when displaying as governed object table
  "uiSubtitle": "string",

  // Fontawesome icon to use for this object type
  "uiIconClass": "string",

  // Search terms for UI Search
  "uiSearchTerms": ["string"],

  // List of properties and fields to display as governed object table columns
  "uiColumns": ["string"]
}