Skip to main content

IIdentityStorePhoneNumber

Interface in AWS.IdentityStore

Interface for IdentityStore PhoneNumber.

Properties​

Primary​

property Primary: TOptional<Boolean>

Indicates whether this is the user's primary phone number.

Set this property to true to designate the phone number as the user's default contact number. Only one number in the list should be marked as primary.

Type​

property Type: string

The classification of the phone number, such as work, mobile, or a custom label.

This value indicates the context in which the phone number is used. Common values include:

  • work – Business contact number.
  • mobile – Personal or cellular number.
  • fax – Facsimile number.
  • other – Any other context. Custom string values are also supported.

Value​

property Value: string

The user's phone number in international format.

This property contains the actual telephone number, such as +1-202-555-0142. It may include country code, area code, and extensions. The format is not strictly validated by the Identity Store API, but it is recommended to follow E.164 format.