Test

Test sends a test email to verify the provider configuration works end-to-end.

POST /api/v1/settings/email-provider/test

Test

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.Test(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.TestTenantEmailProviderResponse != nil {
        // handle response
    }
}

200

{
  "message": "<string>",
  "success": 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.

Body

application/json

The TestTenantEmailProviderRequest message.

testRecipientEmail · string

The email address to send the test email to.

Response

200 - application/json

Successful response

The TestTenantEmailProviderResponse message.

message · string

Human-readable detail about the result.

success · boolean

Whether the test email was sent successfully.