Single Sign-On Integration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sendgrid/main/json-schema/sendgrid-sso-integration-schema.json",
  "title": "Single Sign-On Integration",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendgrid-sso-settings-api-openapi.yml#/components/schemas/SsoIntegration",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)"
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates if the integration is enabled."
    },
    "signin_url": {
      "type": "string",
      "description": "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_url": {
      "type": "string",
      "description": "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_id": {
      "type": "string",
      "description": "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_integration": {
      "type": "boolean",
      "description": "Indicates if the integration is complete."
    },
    "last_updated": {
      "type": "number",
      "description": "A timestamp representing the last time the configuration was modified."
    },
    "id": {
      "type": "string",
      "description": "A unique ID assigned to the configuration by SendGrid."
    },
    "single_signon_url": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "enabled",
    "entity_id",
    "last_updated",
    "name",
    "signin_url",
    "signout_url"
  ]
}