Menu

Expand
Rate this page:

Account Provisioning API: Account Operations

The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customers. This API is for companies that have a formal reseller partnership with Twilio SendGrid.

You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio SendGrid Subusers feature, which is available with Pro and Premier plans.

The Account Provisioning API account operations allow you to create, retrieve, and authenticate customer accounts.

Single Sign-On

The Single Sign-On operation authenticates a customer that you specify by account ID with the Twilio SendGrid user interface. The customer will be authenticated as an Admin Teammate with all the permissions to manage any aspect of their account, including API keys, additional teammates, and domain authentication.

A successful request to this endpoint generates a redirect containing a one-time authorization code used to log the user into the Twilio SendGrid UI. This one-time code is good for 60 seconds and can be used for login once, ensuring that any type of man-in-the-middle or replay attack can be securely blocked. This allows you to manage your customers' authentication credentials without sharing any of the information with Twilio SendGrid.

This SSO flow is limited to authentication on the base Admin Teammate. It cannot be used for SSO on a subsequently created teammate or subuser whose credentials will be managed through Twilio SendGrid.

POST /v3/partners/accounts/{accountID}/sso

Base url: https://api.sendgrid.com

Authenticates and logs in a user to Twilio Sendgrid as a specific admin identity configured for SSO by partner. Any additional teammates or subusers will need to log in directly via app.sendgrid.com

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

accountID
string

Twilio SendGrid account ID

default: None
required

Responses

No response body.
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
Loading Code Sample...
        
        

        Authenticate a customer account user

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!

              thanks-feedback-gif