On this page

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

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

POST/v3/sso/integrations

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 create an SSO integration.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredDescriptionChild properties

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_integrationbooleanOptional

Indicates if the integration is complete.

Responses

200400401403429500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

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.

Create an SSO Integration

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  name: "Miss Christine Morgan",
6  enabled: false,
7  signin_url: "http://day-charles.info/",
8  signout_url: "http://day-charles.info/",
9  entity_id: "ZGkrHSypTsudrGkmdpJJ",
10};
11
12const request = {
13  url: `/v3/sso/integrations`,
14  method: "POST",
15  body: data,
16};
17
18client
19  .request(request)
20  .then(([response, body]) => {
21    console.log(response.statusCode);
22    console.log(response.body);
23  })
24  .catch((error) => {
25    console.error(error);
26  });