Menu

Single Sign-On Settings

Twilio SendGrid Single Sign-On is currently in beta. The following documentation and product interface may change as the product is improved.

Known limitations during beta
Twilio SendGrid SSO does not currently support granting an SSO user access to more than one Subuser without granting the SSO user administrator access at the top level of your Twilio SendGrid account.

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.

Update an SSO Integration

Update an SSO Integration

PATCH /sso/integrations/{id}

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.

Request Body

object
name
string

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

required
enabled
boolean

Indicates if the integration is enabled.

required
signin_url
string

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.

required
signout_url
string

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.

required
entity_id
string

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.

required
completed_integration
boolean

Indicates if the integration is complete.

Path Parameters

id
string
default: None
required

Query String

si
boolean

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

default: None

Responses

object
name
string

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

required
enabled
boolean

Indicates if the integration is enabled.

required
signin_url
string

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.

required
signout_url
string

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.

required
entity_id
string

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.

required
completed_integration
boolean

Indicates if the integration is complete.

last_updated
number

A timestamp representing the last time the configuration was modified.

required
id
string

A unique ID assigned to the configuration by SendGrid.

single_signon_url
string

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_url
string

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.

array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
array[object]
message
string
field
string or null
error_id
string
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more