Skip to contentSkip to navigationSkip to topbar
On this page

Get an SSO Certificate



API Overview

api-overview page anchor

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(link takes you to an external page).

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.


GET/v3/sso/certificates/{cert_id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve an individual SSO certificate.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
certIdstring
required
200400401403429500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
publicCertificatestring

Optional

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.


idnumber

Optional

A unique ID assigned to the certificate by SendGrid.


notBeforenumber

Optional

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


notAfternumber

Optional

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


intergrationIdstring

Optional

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

Get an SSO CertificateLink to code sample: Get an SSO Certificate
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const cert_id = "cert_id";
5
6
const request = {
7
url: `/v3/sso/certificates/${cert_id}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});