Get active SMTP Configuration​
Returns the active SMTP configuration from the system. This is used to send E-Mails to the users.
- 200
- 403
- 404
- default
A successful response.
Schema
smtpConfig object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMTP_CONFIG_STATE_UNSPECIFIED
, SMTP_CONFIG_ACTIVE
, SMTP_CONFIG_INACTIVE
]
Default value: SMTP_CONFIG_STATE_UNSPECIFIED
{
"smtpConfig": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.841Z",
"changeDate": "2024-06-13T06:44:38.841Z",
"resourceOwner": "69629023906488334"
},
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud",
"state": "SMTP_CONFIG_STATE_UNSPECIFIED",
"description": "Mailjet",
"id": "string"
}
}
Schema
smtpConfig object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMTP_CONFIG_STATE_UNSPECIFIED
, SMTP_CONFIG_ACTIVE
, SMTP_CONFIG_INACTIVE
]
Default value: SMTP_CONFIG_STATE_UNSPECIFIED
{
"smtpConfig": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.841Z",
"changeDate": "2024-06-13T06:44:38.841Z",
"resourceOwner": "69629023906488334"
},
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud",
"state": "SMTP_CONFIG_STATE_UNSPECIFIED",
"description": "Mailjet",
"id": "string"
}
}
Schema
smtpConfig object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMTP_CONFIG_STATE_UNSPECIFIED
, SMTP_CONFIG_ACTIVE
, SMTP_CONFIG_INACTIVE
]
Default value: SMTP_CONFIG_STATE_UNSPECIFIED
{
"smtpConfig": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.841Z",
"changeDate": "2024-06-13T06:44:38.841Z",
"resourceOwner": "69629023906488334"
},
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud",
"state": "SMTP_CONFIG_STATE_UNSPECIFIED",
"description": "Mailjet",
"id": "string"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}