Get Email provider by its id
GET/email/:id
Get a specific Email provider by its ID.
Request​
Path Parameters
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
config
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: [EMAIL_PROVIDER_STATE_UNSPECIFIED, EMAIL_PROVIDER_ACTIVE, EMAIL_PROVIDER_INACTIVE]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-21T10:51:29.799Z",
      "changeDate": "2025-03-21T10:51:29.799Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
    "description": "string",
    "smtp": {
      "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"
    },
    "http": {
      "endpoint": "string"
    }
  }
}
- Schema
- Example (from schema)
Schema
config
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: [EMAIL_PROVIDER_STATE_UNSPECIFIED, EMAIL_PROVIDER_ACTIVE, EMAIL_PROVIDER_INACTIVE]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-21T10:51:29.800Z",
      "changeDate": "2025-03-21T10:51:29.800Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
    "description": "string",
    "smtp": {
      "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"
    },
    "http": {
      "endpoint": "string"
    }
  }
}
- Schema
- Example (from schema)
Schema
config
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: [EMAIL_PROVIDER_STATE_UNSPECIFIED, EMAIL_PROVIDER_ACTIVE, EMAIL_PROVIDER_INACTIVE]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-21T10:51:29.800Z",
      "changeDate": "2025-03-21T10:51:29.800Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
    "description": "string",
    "smtp": {
      "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"
    },
    "http": {
      "endpoint": "string"
    }
  }
}
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
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "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
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}