Twilio SendGrid Single Sign-On API
The Single Sign-On API allows you to manage your SAML 2.0 SSO configurations. You can also work with your SSO integrations using the SSO section of the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Single Sign-On API allows 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 application user interface.
The Single Sign-On Settings operations allow 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.
The Single Sign-On Certificates operations allow you to create, modify, and delete SSO certificates. A SAML certificate allows your IdP and Twilio SendGrid to verify requests are coming from one another using the public_certificate and integration_id parameters.
The Single Sign-On Teammates operations allow you to add and modify SSO Teammates. SSO Teammates are the individual user accounts who will access your Twilio SendGrid account with SSO credentials. To retrieve or delete an SSO Teammate, you will use the separate Teammates API.
Endpoints 12
SSO Certificates
- POSTCreate an SSO Certificate
/v3/sso/certificatesThis endpoint allows you to create an SSO certificate. - GETGet an SSO Certificate
/v3/sso/certificates/:cert_idThis endpoint allows you to retrieve an individual SSO certificate. - DELETEDelete an SSO Certificate
/v3/sso/certificates/:cert_idThis endpoint allows you to delete an SSO certificate. You can retrieve a certificate's ID from the response provided by the "Get All SSO Integrations"… - PATCHUpdate SSO Certificate
/v3/sso/certificates/:cert_idThis endpoint allows you to update an existing certificate by ID. You can retrieve a certificate's ID from the response provided by the "Get All SSO… - GETGet All SSO Certificates by Integration
/v3/sso/integrations/:integration_id/certificatesThis endpoint allows you to retrieve all your IdP configurations by configuration ID. The integration_id expected by this endpoint is the id returned in the…
SSO Settings
- GETGet All SSO Integrations
/v3/sso/integrations?si=trueThis endpoint allows you to retrieve all SSO integrations tied to your Twilio SendGrid account. The IDs returned by this endpoint can be used by the APIs… - POSTCreate an SSO Integration
/v3/sso/integrationsThis endpoint allows you to create an SSO integration. - GETGet an SSO Integration
/v3/sso/integrations/:id?si=trueThis endpoint allows you to retrieve an SSO integration by ID. You can retrieve the IDs for your configurations from the response provided by the "Get All SSO… - DELETEDelete an SSO Integration
/v3/sso/integrations/:idThis endpoint allows you to delete an IdP configuration by ID. You can retrieve the IDs for your configurations from the response provided by the "Get All SSO… - PATCHUpdate an SSO Integration
/v3/sso/integrations/:id?si=trueThis 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 Teammates
- POSTCreate an SSO Teammate.
/v3/sso/teammatesThis endpoint allows you to create an SSO Teammate. The email address provided for the Teammate will also function as the Teammate's username. Once created,… - PATCHEdit an SSO Teammate
/v3/sso/teammates/:usernameThis endpoint allows you to modify an existing SSO Teammate. Only the parent user and Teammates with admin permissions can update another Teammate's…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 12 operations on 7 pathsGET 4POST 3PATCH 3DELETE 2
- Main resources
- SSO Certificates 5SSO Settings 5SSO Teammates 2
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Single Sign-On API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Single Sign-On API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create an SSO Certificate” (POST /v3/sso/certificates), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Single Sign-On API?
The Single Sign-On API allows you to manage your SAML 2.0 SSO configurations. You can also work with your SSO integrations using the SSO section of the… It is listed under Communication and has 12 endpoints.
Who publishes the Twilio SendGrid Single Sign-On API?
It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio SendGrid Single Sign-On API?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid Single Sign-On API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Single Sign-On API have?
12 operations on 7 paths (4 GET, 3 POST, 3 PATCH, 2 DELETE). The largest groups are SSO Certificates, SSO Settings, SSO Teammates.
Is forking the Twilio SendGrid Single Sign-On API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.