# code-ninja99/terraform-provider-sendgrid architecture

> Architecture diagram of the GitHub repository code-ninja99/terraform-provider-sendgrid, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/code-ninja99/terraform-provider-sendgrid
- Repository: https://github.com/code-ninja99/terraform-provider-sendgrid

## Overview

This is a Terraform provider for managing SendGrid configuration. Terraform configuration and provider credentials initiate the workflow; provider resources and data sources translate plans or lookups into SendGrid client operations, which call the SendGrid v3 API and return state or data. The repository’s documented resource surface includes API keys, domain authentication and validation, IP allowlists, link branding, sender verification, subusers, and teammates. Provider registration and several resource-to-client calls are not shown in the excerpts, so those links are marked unverified rather than asserted as inspected.

Main entry points: [`internal/provider/provider.go`](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/provider.go) (Provider configuration), [`client/client.go`](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/client.go) (HTTP API client), [`client/domain.go`](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/domain.go) (Domain API operations), [`internal/provider/domain_authentication_resource.go`](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_authentication_resource.go) (Domain authentication)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Provider interface"]
  node_provider_main["Provider process<br/>[main.go]"]
  node_provider_config["Provider configuration<br/>[provider.go]"]
end

subgraph group_domains["Domain configuration"]
  node_domain_auth["Domain authentication"]
  node_domain_lookup["Domain auth lookup"]
  node_domain_validation["Domain validation"]
  node_domain_subuser["Domain-subuser association"]
  node_link_brand["Link branding"]
  node_link_lookup["Link brand lookup"]
  node_link_validate["Link validation"]
end

subgraph group_accounts["Account configuration"]
  node_api_key["API key resource"]
  node_ip_resource["IP allowlist resource"]
  node_ip_lookup["IP allowlist lookup"]
  node_sender["Single sender"]
  node_subuser["Subuser resource"]
  node_subuser_lookup["Subuser lookup"]
  node_teammate["Teammate resource"]
  node_teammate_lookup["Teammate lookup"]
  node_permissions["Permission definitions<br/>[permission.go]"]
end

subgraph group_client["SendGrid client"]
  node_http_client["HTTP API client<br/>[client.go]"]
  node_domain_client["Domain API operations<br/>[domain.go]"]
  node_link_client["Link API operations<br/>[link.go]"]
  node_teammate_client["Teammate API operations<br/>[tmate.go]"]
end

node_terraform(("Terraform"))
node_sendgrid_api{{"SendGrid API"}}

node_terraform -->|"starts provider"| node_provider_main
node_provider_main -.->|"serves provider"| node_provider_config
node_terraform -.->|"configures credentials"| node_provider_config
node_provider_config -.->|"registers resources"| node_api_key
node_provider_config -.->|"registers resources"| node_domain_auth
node_provider_config -.->|"registers lookup"| node_domain_lookup
node_provider_config -.->|"registers resources"| node_domain_validation
node_provider_config -.->|"registers resources"| node_domain_subuser
node_provider_config -.->|"registers resources"| node_link_brand
node_provider_config -.->|"registers lookup"| node_link_lookup
node_provider_config -.->|"registers resources"| node_link_validate
node_provider_config -.->|"registers resources"| node_ip_resource
node_provider_config -.->|"registers lookup"| node_ip_lookup
node_provider_config -.->|"registers resources"| node_sender
node_provider_config -.->|"registers resources"| node_subuser
node_provider_config -.->|"registers lookup"| node_subuser_lookup
node_provider_config -.->|"registers resources"| node_teammate
node_provider_config -.->|"registers lookup"| node_teammate_lookup
node_domain_auth -.->|"calls domain operations"| node_domain_client
node_domain_lookup -.->|"calls domain lookup"| node_domain_client
node_domain_subuser -->|"calls association"| node_domain_client
node_link_brand -->|"calls link operations"| node_link_client
node_http_client -->|"sends HTTP requests"| node_sendgrid_api
node_domain_client -->|"uses request methods"| node_http_client
node_link_client -->|"uses request methods"| node_http_client
node_teammate_client -->|"uses request methods"| node_http_client
node_domain_auth -.->|"validation capability"| node_domain_validation
node_link_brand -.->|"validation capability"| node_link_validate

click node_provider_main "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/main.go"
click node_provider_config "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/provider.go"
click node_api_key "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/api_key_resource.go"
click node_domain_auth "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_authentication_resource.go"
click node_domain_lookup "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_authentication_data_source.go"
click node_domain_validation "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_validation_resource.go"
click node_domain_subuser "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_auth_subuser_resource.go"
click node_link_brand "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_branding_resource.go"
click node_link_lookup "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_branding_data_source.go"
click node_link_validate "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_brand_validate_resource.go"
click node_ip_resource "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/ipwhitelist_resource.go"
click node_ip_lookup "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/ipwhitelist_data_source.go"
click node_sender "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/singlesender_resource.go"
click node_subuser "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/subuser_resource.go"
click node_subuser_lookup "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/subuser_data_source.go"
click node_teammate "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/teammate_resource.go"
click node_teammate_lookup "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/teammate_data_source.go"
click node_permissions "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/permission.go"
click node_http_client "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/client.go"
click node_domain_client "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/domain.go"
click node_link_client "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/link.go"
click node_teammate_client "https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/tmate.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_provider_main,node_provider_config toneBlue
class node_domain_auth,node_domain_lookup,node_domain_validation,node_domain_subuser,node_link_brand,node_link_lookup,node_link_validate toneAmber
class node_api_key,node_ip_resource,node_ip_lookup,node_sender,node_subuser,node_subuser_lookup,node_teammate,node_teammate_lookup,node_permissions,node_sendgrid_api toneMint
class node_http_client,node_domain_client,node_link_client,node_teammate_client toneRose
class node_terraform toneIndigo
```

## Components

### Provider interface

- [Provider process](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/main.go): `main.go`
- [Provider configuration](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/provider.go): `internal/provider/provider.go`

### Domain configuration

- [Domain authentication](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_authentication_resource.go): `internal/provider/domain_authentication_resource.go`
- [Domain auth lookup](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_authentication_data_source.go): `internal/provider/domain_authentication_data_source.go`
- [Domain validation](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_validation_resource.go): `internal/provider/domain_validation_resource.go`
- [Domain-subuser association](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/domain_auth_subuser_resource.go): `internal/provider/domain_auth_subuser_resource.go`
- [Link branding](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_branding_resource.go): `internal/provider/link_branding_resource.go`
- [Link brand lookup](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_branding_data_source.go): `internal/provider/link_branding_data_source.go`
- [Link validation](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/link_brand_validate_resource.go): `internal/provider/link_brand_validate_resource.go`

### Account configuration

- [API key resource](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/api_key_resource.go): `internal/provider/api_key_resource.go`
- [IP allowlist resource](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/ipwhitelist_resource.go): `internal/provider/ipwhitelist_resource.go`
- [IP allowlist lookup](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/ipwhitelist_data_source.go): `internal/provider/ipwhitelist_data_source.go`
- [Single sender](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/singlesender_resource.go): `internal/provider/singlesender_resource.go`
- [Subuser resource](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/subuser_resource.go): `internal/provider/subuser_resource.go`
- [Subuser lookup](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/subuser_data_source.go): `internal/provider/subuser_data_source.go`
- [Teammate resource](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/teammate_resource.go): `internal/provider/teammate_resource.go`
- [Teammate lookup](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/teammate_data_source.go): `internal/provider/teammate_data_source.go`
- [Permission definitions](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/internal/provider/permission.go): `internal/provider/permission.go`

### SendGrid client

- [HTTP API client](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/client.go): `client/client.go`
- [Domain API operations](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/domain.go): `client/domain.go`
- [Link API operations](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/link.go): `client/link.go`
- [Teammate API operations](https://github.com/code-ninja99/terraform-provider-sendgrid/blob/main/client/tmate.go): `client/tmate.go`

### Other components

- **Terraform**
- **SendGrid API**

## Connections

- Terraform → Provider process: starts provider (evidence: `main.go`)
- Provider process → Provider configuration: serves provider
- Terraform → Provider configuration: configures credentials
- Provider configuration → API key resource: registers resources
- Provider configuration → Domain authentication: registers resources
- Provider configuration → Domain auth lookup: registers lookup
- Provider configuration → Domain validation: registers resources
- Provider configuration → Domain-subuser association: registers resources
- Provider configuration → Link branding: registers resources
- Provider configuration → Link brand lookup: registers lookup
- Provider configuration → Link validation: registers resources
- Provider configuration → IP allowlist resource: registers resources
- Provider configuration → IP allowlist lookup: registers lookup
- Provider configuration → Single sender: registers resources
- Provider configuration → Subuser resource: registers resources
- Provider configuration → Subuser lookup: registers lookup
- Provider configuration → Teammate resource: registers resources
- Provider configuration → Teammate lookup: registers lookup
- Domain authentication → Domain API operations: calls domain operations
- Domain auth lookup → Domain API operations: calls domain lookup
- Domain-subuser association → Domain API operations: calls association (evidence: `internal/provider/domain_auth_subuser_resource.go`)
- Link branding → Link API operations: calls link operations (evidence: `internal/provider/link_branding_resource.go`)
- HTTP API client → SendGrid API: sends HTTP requests (evidence: `client/client.go`)
- Domain API operations → HTTP API client: uses request methods (evidence: `client/domain.go`)
- Link API operations → HTTP API client: uses request methods (evidence: `client/link.go`)
- Teammate API operations → HTTP API client: uses request methods (evidence: `client/tmate.go`)
- Domain authentication → Domain validation: validation capability
- Link branding → Link validation: validation capability
