Menu

Expand
Rate this page:

Single Sign-On Teammates

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 Teammates API allows 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 Teammates API.

For more information about managing SSO Teammates, see the Twilio SendGrid SSO documentation.

Create SSO Teammate

POST /v3/sso/teammates

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

This endpoint allows you to create an SSO Teammate.

The email provided for this user will also function as the Teammate’s username.

Request Body

object
first_name
string

The Teammate’s first name.

required
last_name
string

The Teammate’s last name.

required
email
string

The Teammate’s email address. This email address will also function as the Teammate’s username and must match the address assigned to the user in your IdP. This address cannot be changed after the Teammate is created.

format: email
required
is_admin
boolean

Indicates if the Teammate has admin permissions.

is_read_only
boolean

Indicates if the Teammate has read_only permissions.

scopes
array[string]

The permission scopes assigned to the Teammate.

required

Responses

object
first_name
string

The Teammate’s first name.

required
last_name
string

The Teammate’s last name.

required
email
string

The Teammate’s email address. This email address will also function as the Teammate’s username and must match the address assigned to the user in your IdP. This address cannot be changed after the Teammate is created.

format: email
required
is_admin
boolean

Indicates if the Teammate has admin permissions.

is_read_only
boolean

Indicates if the Teammate has read_only permissions.

username
string

This should be set to the Teammate's email address.

is_sso
boolean

Indicates if the Teammate authenticates with SendGrid using SSO or with a username and password.

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!

              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!

              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