Skip to main content

Get active SMTP Configuration​

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

Responses

A successful response.

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
    state string

    Possible values: [SMTP_CONFIG_STATE_UNSPECIFIED, SMTP_CONFIG_ACTIVE, SMTP_CONFIG_INACTIVE]

    Default value: SMTP_CONFIG_STATE_UNSPECIFIED

    description string
    id string
GET /smtp

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
Accept
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'