Get SMTP Configuration

Returns the SMTP configuration from the system. This is used to send E-Mails to the users.

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

smtpConfig object
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
senderAddress string
senderName string
tls boolean
host string
user string
replyToAddress string

{
  "smtpConfig": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-12-01T12:27:37.842Z",
      "changeDate": "2023-12-01T12:27:37.842Z",
      "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"
  }
}

Schema

Example (from schema)

---

Schema

smtpConfig object
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
senderAddress string
senderName string
tls boolean
host string
user string
replyToAddress string

{
  "smtpConfig": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-12-01T12:27:37.842Z",
      "changeDate": "2023-12-01T12:27:37.842Z",
      "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"
  }
}

Schema

Example (from schema)

---

Schema

smtpConfig object
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
senderAddress string
senderName string
tls boolean
host string
user string
replyToAddress string

{
  "smtpConfig": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-12-01T12:27:37.842Z",
      "changeDate": "2023-12-01T12:27:37.842Z",
      "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"
  }
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...