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.
Edit an SSO Teammate
PATCH /v3/sso/teammates/{username}
Base url: https://api.sendgrid.com
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
{
"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
This email address must be the same address assigned to the teammate in your IdP
default: NoneResponses
The Teammate’s street address.
The Teammate’s apartment number, suite number, or other secondary address information that is not part of the physical street address.
The Teammate's city.
The Teammate’s company name.
The Teammate’s country of residence.
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: emailThe Teammate’s stored phone number.
The permission scopes assigned to the Teammate.
The Teammate’s state or province.
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, teammateA website associated with the Teammate
The Teammate’s zip code.
The Teammate’s first name.
The Teammate’s last name.
Indicates if the Teammate has admin permissions.
Indicates if the Teammate has read_only permissions.
This should be set to the Teammate's email address.
Indicates if the Teammate authenticates with SendGrid using SSO or with a username and password.
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.