API referenceSystem
List alias domains and the default alias format
GET
The alias domains this deployment hands out, plus the default format used when a new alias's local part is generated for you.
CognitoUserPoolheader
AuthorizationBearer <token>Cognito user pool ID token. API Gateway validates the token (identity
token: no OAuth scopes are configured on the authorizer) and forwards
its claims; the sub claim is the tenant key.
Domain options.
application/json- response
domains*array<string>Alias domains available for new aliases.
default_alias_format*AliasFormatHow a generated alias local part is produced: random English words joined with separators, or a UUID.
Value in
"random_words""uuid"curl -X GET "https://example.com/domain-options"{ "domains": [ "darkmailer.net" ], "default_alias_format": "random_words"}