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

Update an SSO Integration


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 Single Sign-On Settings API allows you to create, retrieve, modify, and delete SSO integrations for your Twilio SendGrid account. Each integration will correspond to a specific IdP such as Okta, Duo, or Microsoft Azure Active Directory.


Operation overview

operation-overview page anchor

PATCH/v3/sso/integrations/{id}

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

This endpoint allows you to modify an exisiting SSO integration.

You can retrieve the IDs for your configurations from the response provided by the "Get All SSO Integrations" endpoint.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
idstringrequired
siboolean

If this parameter is set to true, the response will include the completed_integration field.

Schema
namestringrequired

The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)


enabledbooleanrequired

Indicates if the integration is enabled.


signin_urlstringrequired

The IdP's SAML POST endpoint. This endpoint should receive requests and initiate an SSO login flow. This is called the "Embed Link" in the Twilio SendGrid UI.


signout_urlstringrequired

This URL is relevant only for an IdP-initiated authentication flow. If a user authenticates from their IdP, this URL will return them to their IdP when logging out.


entity_idstringrequired

An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction. This is called the "SAML Issuer ID" in the Twilio SendGrid UI.


completed_integrationboolean

Indicates if the integration is complete.

200400401403429500
SchemaExample
namestring

The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)


enabledboolean

Indicates if the integration is enabled.


signin_urlstring

The IdP's SAML POST endpoint. This endpoint should receive requests and initiate an SSO login flow. This is called the "Embed Link" in the Twilio SendGrid UI.


signout_urlstring

This URL is relevant only for an IdP-initiated authentication flow. If a user authenticates from their IdP, this URL will return them to their IdP when logging out.


entity_idstring

An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction. This is called the "SAML Issuer ID" in the Twilio SendGrid UI.


completed_integrationboolean

Indicates if the integration is complete.


last_updatednumber

A timestamp representing the last time the configuration was modified.


idstring

A unique ID assigned to the configuration by SendGrid.


single_signon_urlstring

The URL where your IdP should POST its SAML response. This is the Twilio SendGrid URL that is responsible for receiving and parsing a SAML assertion. This is the same URL as the Audience URL when using SendGrid.


audience_urlstring

The URL where your IdP should POST its SAML response. This is the Twilio SendGrid URL that is responsible for receiving and parsing a SAML assertion. This is the same URL as the Single Sign-On URL when using SendGrid.

Update an SSO Integration

update-an-sso-integration page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_26
const client = require('@sendgrid/client');
_26
client.setApiKey(process.env.SENDGRID_API_KEY);
_26
_26
const id = "ZGkrHSypTsudrGkmdpJJ";
_26
const data = {
_26
"name": "Miss Christine Morgan",
_26
"enabled": false,
_26
"signin_url": "http://day-charles.info/",
_26
"signout_url": "http://day-charles.info/",
_26
"entity_id": "ZGkrHSypTsudrGkmdpJJ"
_26
};
_26
_26
const request = {
_26
url: `/v3/sso/integrations/${id}`,
_26
method: 'PATCH',
_26
body: data
_26
}
_26
_26
client.request(request)
_26
.then(([response, body]) => {
_26
console.log(response.statusCode);
_26
console.log(response.body);
_26
})
_26
.catch(error => {
_26
console.error(error);
_26
});


Rate this page: