Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Get All SSO Certificates by Integration



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/integrations/{integration_id}/certificates

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

This endpoint allows you to retrieve all your IdP configurations by configuration ID.

The integration_id expected by this endpoint is the id returned in the response by the "Get All SSO Integrations" endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
integration_idstringrequired

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

200400401403429500
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
public_certificatestring

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

A unique ID assigned to the certificate by SendGrid.


not_beforenumber

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


not_afternumber

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


intergration_idstring

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

Get All SSO Certificates by Integration

get-all-sso-certificates-by-integration page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const integration_id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19
const request = {
_19
url: `/v3/sso/integrations/${integration_id}/certificates`,
_19
method: 'GET',
_19
_19
}
_19
_19
client.request(request)
_19
.then(([response, body]) => {
_19
console.log(response.statusCode);
_19
console.log(response.body);
_19
})
_19
.catch(error => {
_19
console.error(error);
_19
});


Rate this page: