Microsoft Graph · Schema

attributeDefinition

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
anchor boolean true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the
apiExpressions array
caseExact boolean true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.
defaultValue string The default value of the attribute.
flowNullValues boolean 'true' to allow null values for attributes.
metadata array Metadata for the given object.
multivalued boolean true if an attribute can have multiple values. Default is false.
mutability object
name string Name of the attribute. Must be unique within the object definition. Not nullable.
referencedObjects array For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
required boolean true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used.
type object
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphattributedefinition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.attributeDefinition",
  "title": "attributeDefinition",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "anchor": {
      "type": "boolean",
      "description": "true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization."
    },
    "apiExpressions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.stringKeyStringValuePair"
      }
    },
    "caseExact": {
      "type": "boolean",
      "description": "true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute."
    },
    "defaultValue": {
      "type": "string",
      "description": "The default value of the attribute.",
      "nullable": true
    },
    "flowNullValues": {
      "type": "boolean",
      "description": "'true' to allow null values for attributes."
    },
    "metadata": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.attributeDefinitionMetadataEntry"
      },
      "description": "Metadata for the given object."
    },
    "multivalued": {
      "type": "boolean",
      "description": "true if an attribute can have multiple values. Default is false."
    },
    "mutability": {
      "$ref": "#/components/schemas/microsoft.graph.mutability"
    },
    "name": {
      "type": "string",
      "description": "Name of the attribute. Must be unique within the object definition. Not nullable.",
      "nullable": true
    },
    "referencedObjects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.referencedObject"
      },
      "description": "For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object)."
    },
    "required": {
      "type": "boolean",
      "description": "true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error."
    },
    "type": {
      "$ref": "#/components/schemas/microsoft.graph.attributeType"
    },
    "@odata.type": {
      "type": "string"
    }
  }
}