Email object representation

The email object representation and fields are described below.

email was introduced in API version V1

email has not been marked for deprecation

Usages

Description

Representation of an email address associated with an identity

Example create representation

{
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "email" : "test@example.com"
}

Example response representation

{
  "urn" : "acd987b2-feb0-4e60-b192-82bfbd37bf59",
  "url" : "/n/v1/email/acd987b2-feb0-4e60-b192-82bfbd37bf59",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "email" : "test@example.com"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN for the email
url	URL represented as a string	The address to access the email
identity	identity	The identity the email is associated with	Required on create.
email	Email address value	email address associated with the identity	Required on create.