Single Sign-On Teammates PATCH Response.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sendgrid/main/json-schema/sendgrid-patch-sso-teammates200-schema.json",
  "title": "Single Sign-On Teammates PATCH Response.",
  "description": "Successful SSO Teammates PATCH response.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendgrid-sso-teammates-api-openapi.yml#/components/schemas/PatchSsoTeammates200",
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "description": "The Teammate's street address."
    },
    "address2": {
      "type": "string",
      "description": "The Teammate's apartment number, suite number, or other secondary address information that is not part of the physical street address."
    },
    "city": {
      "type": "string",
      "description": "The Teammate's city."
    },
    "company": {
      "type": "string",
      "description": "The Teammate's company name."
    },
    "country": {
      "type": "string",
      "description": "The Teammate's country of residence."
    },
    "username": {
      "type": "string",
      "description": "The Teammate's username. This property is set to the Teammate's email address."
    },
    "phone": {
      "type": "string",
      "description": "The Teammate's phone number."
    },
    "state": {
      "type": "string",
      "description": "The Teammate's state or province."
    },
    "user_type": {
      "type": "string",
      "description": "A Teammate can be an `admin`, `owner`, or `teammate`. Each role is associated with the scope of the Teammate's permissions.",
      "$ref": "#/$defs/UserType"
    },
    "website": {
      "type": "string",
      "description": "A website associated with the Teammate."
    },
    "zip": {
      "type": "string",
      "description": "The Teammate's zip code."
    },
    "first_name": {
      "type": "string",
      "description": "The Teammate's first name."
    },
    "last_name": {
      "type": "string",
      "description": "The Teammate's last name."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Teammate's email address. This email address also functions 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."
    },
    "is_admin": {
      "type": "boolean",
      "description": "Indicates if the Teammate has administrator permissions. When set to `true`, the Teammate is an admin."
    },
    "is_sso": {
      "type": "boolean",
      "description": "Indicates how the Teammate authenticates with SendGrid. When set to `true`, the Teammate will access SendGrid via SSO and their IdP. When set to `false`, the Teammate will authenticate directly with SendGrid via a username and password."
    },
    "scopes": {
      "type": "array",
      "description": "The permissions or scopes currently assigned to the Teammate. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of available scopes.",
      "items": {
        "type": "string"
      }
    },
    "has_restricted_subuser_access": {
      "type": "boolean",
      "description": "When this property is set to `true`, the Teammate has permissions to operate only on behalf of a Subuser. This property value is `true` when the `subuser_access` property is not empty. The `subuser_access` property determines which Subusers the Teammate may act on behalf of."
    },
    "subuser_access": {
      "type": "array",
      "description": "Specifies which Subusers the Teammate may access and act on behalf of. If this property is populated, the `has_restricted_subuser_access` property will be `true`.",
      "items": {
        "type": "object",
        "description": "An array of Subusers to which the Teammate has access.",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The ID of a Subuser to which the Teammate has access. You can retrieve Subuser IDs from the [Subusers API](https://docs.sendgrid.com/api-reference/subusers-api/)."
          },
          "username": {
            "type": "string",
            "description": "The username of a Subuser to which the Teammate has access."
          },
          "email": {
            "type": "string",
            "description": "The email address of a Subuser to which the Teammate has access."
          },
          "disabled": {
            "type": "boolean",
            "description": "Indicates if the Subuser is active for the SendGrid account."
          },
          "permission_type": {
            "type": "string",
            "description": "The level of access the Teammate has to the specified Subuser. This property value may be either `admin` or `restricted`. When is property is set to `restricted`, the Teammate has only the permissions assigned in the `scopes` property.",
            "$ref": "#/$defs/PermissionType1"
          },
          "scopes": {
            "type": "array",
            "description": "The permissions or scopes that the Teammate can access on behalf of the Subuser. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of available scopes.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "$defs": {
    "PermissionType1": {
      "type": "string",
      "enum": [
        "admin",
        "restricted"
      ]
    },
    "UserType": {
      "type": "string",
      "enum": [
        "admin",
        "owner",
        "teammate"
      ]
    }
  }
}