authenticationAttributeCollectionInputConfiguration

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name	Type	Description
attribute	string	The built-in or custom attribute for which a value is being collected.
defaultValue	string	The default value of the attribute displayed to the end user. The capability to set the default value isn't available through the Microsoft Entra admin center.
editable	boolean	Defines whether the attribute is editable by the end user.
hidden	boolean	Defines whether the attribute is displayed to the end user. The capability to hide isn't available through the Microsoft Entra admin center.
inputType	object
label	string	The label of the attribute field that's displayed to end user, unless overridden.
options	array	The option values for certain multiple-option input types.
required	boolean	Defines whether the field is required.
validationRegEx	string	The regex for the value of the field. For more information about the supported regexes, see validationRegEx values for inputType objects. To understand how to specify regexes, see the Regular expressi
writeToDirectory	boolean	Defines whether Microsoft Entra ID stores the value that it collects.
@odata.type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.authenticationAttributeCollectionInputConfiguration",
  "title": "authenticationAttributeCollectionInputConfiguration",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "attribute": {
      "type": "string",
      "description": "The built-in or custom attribute for which a value is being collected."
    },
    "defaultValue": {
      "type": "string",
      "description": "The default value of the attribute displayed to the end user. The capability to set the default value isn't available through the Microsoft Entra admin center.",
      "nullable": true
    },
    "editable": {
      "type": "boolean",
      "description": "Defines whether the attribute is editable by the end user.",
      "nullable": true
    },
    "hidden": {
      "type": "boolean",
      "description": "Defines whether the attribute is displayed to the end user. The capability to hide isn't available through the Microsoft Entra admin center.",
      "nullable": true
    },
    "inputType": {
      "$ref": "#/components/schemas/microsoft.graph.authenticationAttributeCollectionInputType"
    },
    "label": {
      "type": "string",
      "description": "The label of the attribute field that's displayed to end user, unless overridden."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.authenticationAttributeCollectionOptionConfiguration"
      },
      "description": "The option values for certain multiple-option input types."
    },
    "required": {
      "type": "boolean",
      "description": "Defines whether the field is required.",
      "nullable": true
    },
    "validationRegEx": {
      "type": "string",
      "description": "The regex for the value of the field. For more information about the supported regexes, see validationRegEx values for inputType objects. To understand how to specify regexes, see the Regular expressions cheat sheet.",
      "nullable": true
    },
    "writeToDirectory": {
      "type": "boolean",
      "description": "Defines whether Microsoft Entra ID stores the value that it collects.",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}