Menu

Single Sign-On Teammates

Twilio SendGrid Single Sign-On is currently in beta. The following documentation and product interface may change as the product is improved.

Known limitations during beta
Twilio SendGrid SSO does not currently support granting an SSO user access to more than one Subuser without granting the SSO user administrator access at the top level of your Twilio SendGrid account.

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.

Edit an SSO Teammate

Edit an SSO Teammate

PATCH /sso/teammates/{username}

This endpoint allows you to modify an existing SSO Teammate.

To turn a teammate into an admin, the request body should contain the is_admin field set to true. Otherwise, set is_admin to false and pass in all the scopes that a teammate should have.

Only the parent user and Teammates with admin permissions can update another Teammate’s permissions. Admin users can only update permissions.

Request Body

object
first_name
string
last_name
string
scopes
array[string]
is_admin
boolean
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ],
  "is_admin": false
}

Path Parameters

username
string

This email address must be the same address assigned to the teammate in your IdP

format: email
required

Responses

object
address
string

The Teammate’s street address.

address2
string

The Teammate’s apartment number, suite number, or other secondary address information that is not part of the physical street address.

city
string

The Teammate's city.

company
string

The Teammate’s company name.

country
string

The Teammate’s country of residence.

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
phone
string

The Teammate’s stored phone number.

scopes
array[string]

The permission scopes assigned to the Teammate.

state
string

The Teammate’s state or province.

user_type
string

A Teammate can be an “admin,” “owner,” or “teammate.” Each role is associated with the scope of the Teammate’s permissions.

Allowed Values: admin, owner, teammate
website
string

A website associated with the Teammate

zip
string

The Teammate’s zip code.

first_name
string

The Teammate’s first name.

required
last_name
string

The Teammate’s last name.

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
error_id
string
array[object]
message
string
field
string
error_id
string
array[object]
message
string
field
string
error_id
string
array[object]
message
string
field
string
error_id
string
array[object]
message
string
field
string
error_id
string

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.