Skip to contentSkip to navigationSkip to topbar
On this page

Update 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.


PATCH/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 update an existing certificate by ID.

You can retrieve a certificate's ID from the response provided by the "Get All SSO Integrations" endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
cert_idstringrequired
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
public_certificatestring

Optional

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


enabledboolean

Optional

Indicates whether or not the certificate is enabled.


integration_idstring

Optional

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

200400401403429500
SchemaExample
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.

Update SSO CertificateLink to code sample: Update SSO Certificate
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const cert_id = "ZGkrHSypTsudrGkmdpJJ";
5
const data = {
6
public_certificate: "<your x509 certificate>",
7
enabled: false,
8
intergration_id: "b0b98502-9408-4b24-9e3d-31ed7cb15312",
9
};
10
11
const request = {
12
url: `/v3/sso/certificates/${cert_id}`,
13
method: "PATCH",
14
body: data,
15
};
16
17
client
18
.request(request)
19
.then(([response, body]) => {
20
console.log(response.statusCode);
21
console.log(response.body);
22
})
23
.catch((error) => {
24
console.error(error);
25
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.