Get Email Capabilities

GetEmailCapabilities returns a lightweight summary of email capabilities for the current tenant. Intended for non-admin users (automation builders, secret sharers) to check if external email is available without exposing provider configuration details.

GET /api/v1/settings/email-capabilities

GetEmailCapabilities

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.TenantEmailProvider.GetEmailCapabilities(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetEmailCapabilitiesResponse != nil {
        // handle response
    }
}

200

{
  "externalEmailSupported": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Response

200 - application/json

Successful response

The GetEmailCapabilitiesResponse message.

externalEmailSupported · boolean

True when external email addresses (outside C1 users) can be used as recipients in automation email steps. False when only the C1 built-in provider is configured (C1 users only).