PhoneNumber

The phone number associated with the user.

Access ControlAuthenticationIdentity ManagementSingle Sign-On

Properties

Name Type Description
Value object
Type object
Primary object
View JSON Schema on GitHub

JSON Schema

identitystore-phone-number-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-schema/identitystore-phone-number-schema.json",
  "title": "PhoneNumber",
  "description": "The phone number associated with the user.",
  "type": "object",
  "properties": {
    "Value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveStringType"
        },
        {
          "description": "A string containing a phone number. For example, \"8675309\" or \"+1 (800) 123-4567\"."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveStringType"
        },
        {
          "description": "A string representing the type of a phone number. For example, \"Mobile.\""
        }
      ]
    },
    "Primary": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveBooleanType"
        },
        {
          "description": "A Boolean value representing whether this is the primary phone number for the associated resource."
        }
      ]
    }
  }
}