Skip to main content

IIdentityStoreEmail

Interface in AWS.IdentityStore

Interface for IdentityStore Email.

Properties​

Primary​

property Primary: TOptional<Boolean>

Indicates whether this is the user's primary email address.

Set this property to true to designate the email as the default or preferred address. Only one email in the list may be marked as primary.

Type​

property Type: string

The classification of the email address, such as work, home, or a custom value.

This value indicates the context or usage of the email address. Common conventions include:

  • work – Organizational or business email.
  • home – Personal or residential email.
  • other – Any other purpose. Custom string values are also accepted.

Value​

property Value: string

The email address associated with the user.

This property contains the actual email string, such as jane.doe@example.com. Multiple email addresses may be provided, and the format is not strictly validated by the API.