Menu

Expand
Rate this page:

Certificates

The Single Sign-On APIs allow you to manage your SAML 2.0 SSO configurations. You can also work with your SSO integrations using the SSO section of the Twilio SendGrid App.

The Certificates API allows you to create, modify, and delete SSO certificates. A SAML certificate allows your IdP and Twilio SendGrid to verify requests are coming from one another using the public_certificate and integration_id parameters.

For more information about managing SSO Certificates, see the Twilio SendGrid SSO documentation.

Create an SSO Certificate

POST /v3/sso/certificates

Base url: https://api.sendgrid.com

This endpoint allows you to create an SSO certificate.

Request Body

object
public_certificate
string

This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes.

required
enabled
boolean

Indicates if the certificate is enabled.

integration_id
string

An ID that matches a certificate to a specific IdP integration. This is the id returned by the "Get All SSO Integrations" endpoint.

required
{
  "public_certificate": "<your x509 certificate>",
  "enabled": false,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Responses

object
public_certificate
string

This certificate is used by Twilio SendGrid to verify that SAML requests are coming from Okta. This is called the X509 certificate in the Twilio SendGrid UI.

id
number

A unique ID assigned to the certificate by SendGrid.

not_before
number

A unix timestamp (e.g., 1603915954) that indicates the time before which the certificate is not valid.

not_after
number

A unix timestamp (e.g., 1603915954) that indicates the time after which the certificate is no longer valid.

intergration_id
string

An ID that matches a certificate to a specific IdP integration.

{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
Loading Code Sample...
        
        

        Create an SSO Certificate

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif