Masked Emails¶
Manage masked email addresses for privacy protection.
Masked Email¶
Email Address¶
The masked email address.
Text. Read only. Name in the API: email.
Description¶
Description of the masked email address.
Text. Name in the API: description.
Enabled¶
Whether this masked email address is enabled.
On or off. Default: On. Name in the API: enabled.
Account¶
Identifier for the account this masked email address belongs to.
One of your Accounts, chosen from a list. Set when it’s created; can’t be changed afterwards. Name in the API: accountId.
Expiration¶
Expiration Date¶
Expiration date of the email address.
A date and time. Set when it’s created; can’t be changed afterwards. Name in the API: expiresAt.
Created At¶
The date-time the email address was created.
A date and time. Read only. Name in the API: createdAt.
Details¶
Associated Domain¶
The domain name of the site this address was created for, e.g. "https://example.com". This is intended to be added automatically by password managers.
Text. Name in the API: forDomain.
Associated URL¶
A URL pointing back to the integrator's use of this email address, e.g. a custom-uri to open "ACME Password Manager" at the appropriate entry.
Text. Name in the API: url.
Created By¶
The name of the client that created this email address. This will be set by the server automatically based on the credentials used to authenticate the request, e.g. "ACME Password Manager".
Text. Name in the API: createdBy.
Creation Options¶
Email Prefix¶
This is only used on create and otherwise ignored; if supplied, the server-assigned email will start with the given prefix. The string MUST be <= 64 characters in length and MUST only contain characters a-z, 0-9 and _ (underscore).
Text. Set when it’s created; can’t be changed afterwards. Name in the API: emailPrefix.
Email Domain¶
This is only used on create and otherwise ignored; if supplied, the server-assigned email will end with the given domain.
Text. Set when it’s created; can’t be changed afterwards. Name in the API: emailDomain.