provider Single Sign-On Settings PATCH /sso/integrations/{id}
@utdk/sendgrid /sso/integrations/{id}
Update an SSO Integration
**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.
id path required
string
si query
If this parameter is set to `true`, the response will include the `completed_integration` field.
boolean

Try it

Authentication
Configure credentials for Email Activity (beta)
patchSsoIntegrationsId
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.

Parameters

required

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

Input

Indicates if the integration is complete.

required

Indicates if the integration is enabled.

required

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

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

required

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

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.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchSsoIntegrationsId()