Microsoft Graph · Schema

microsoft.graph.phoneAuthenticationMethod

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphphoneauthenticationmethod-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.phoneAuthenticationMethod",
  "title": "microsoft.graph.phoneAuthenticationMethod",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.authenticationMethod"
    },
    {
      "title": "phoneAuthenticationMethod",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "phoneNumber": {
          "type": "string",
          "description": "The phone number to text or call for authentication. Phone numbers use the format +{country code} {number}x{extension}, with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating or updating if they don't match the required format.",
          "nullable": true
        },
        "phoneType": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.authenticationPhoneType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The type of this phone. The possible values are: mobile, alternateMobile, or office."
        },
        "smsSignInState": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.authenticationMethodSignInState"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Whether a phone is ready to be used for SMS sign-in or not. The possible values are: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, ready, or notConfigured, unknownFutureValue."
        },
        "@odata.type": {
          "type": "string",
          "default": "#microsoft.graph.phoneAuthenticationMethod"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.phoneAuthenticationMethod"
}