Skip to content Skip to navigation Skip to topbar

Update SSO Certificate

API Overview

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.

Operation overview

PATCH/v3/sso/certificates/{cert_id}

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

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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

cert_idstringrequired

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

public_certificatestringOptional

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

enabledbooleanOptional

Indicates whether or not the certificate is enabled.

integration_idstringOptional

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

Responses

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 Certificate

Node.js

Python

Java

PHP

Ruby

curl


_24const client = require('@sendgrid/client');
_24client.setApiKey(process.env.SENDGRID_API_KEY);
_24
_24const cert_id = "ZGkrHSypTsudrGkmdpJJ";
_24const data = {
_24  "public_certificate": "<your x509 certificate>",
_24  "enabled": false,
_24  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
_24};
_24
_24const request = {
_24  url: `/v3/sso/certificates/${cert_id}`,
_24  method: 'PATCH',
_24  body: data
_24}
_24
_24client.request(request)
_24  .then(([response, body]) => {
_24    console.log(response.statusCode);
_24    console.log(response.body);
_24  })
_24  .catch(error => {
_24    console.error(error);
_24  });