SendGrid

Overview

Use SendGrid credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

Property	Value
Provider ID	sendgrid
Category	Communication
Credential Type	Bearer Token

Step 1: Get Credentials

Log in to the SendGrid Dashboard

Log in to the SendGrid Dashboard at app.sendgrid.com.

Go to Settings → API Keys

Go to Settings → API Keys at app.sendgrid.com/settings/api_keys.

Create an API Key

Click ‘Create API Key’ and set permissions.

Copy your API key

Copy the generated API key (it won’t be shown again).

Warning

Never share credentials publicly. Store them securely and only enter them in the Alter Vault Developer Portal.

Step 2: Add to Alter Vault

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add SendGrid

Go to Managed Secrets > Add Provider > SendGrid.

Enter credentials

Paste your API Key into the credential field.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

Using in Code

response = await alter_app.request(
    HttpMethod.POST,
    "https://api.sendgrid.com/v3/mail/send",
    grant_id="YOUR_GRANT_ID",
    json={
        "personalizations": [{"to": [{"email": "recipient@example.com"}]}],
        "from": {"email": "sender@YOUR_VERIFIED_DOMAIN"},
        "subject": "Hello",
        "content": [{"type": "text/plain", "value": "Hello from Alter"}],
    },
)

Policy-cataloged operations

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation ID	Families	Method	Provider path
POST_mail-batch	send	POST	/mail/batch
POST_mail-send	send	POST	/mail/send
POST_validations-email	send	POST	/validations/email
POST_whitelabel-dns-email	send	POST	/whitelabel/dns/email
PUT_user-email	admin, send	PUT	/user/email
DELETE-design	delete	DELETE	/designs/{id}
DELETE_access_settings-whitelist-rule_id	admin, delete	DELETE	/access_settings/whitelist/{rule_id}
DELETE_alerts-alert_id	delete	DELETE	/alerts/{alert_id}
DELETE_api_keys-api_key_id	admin, delete	DELETE	/api_keys/{api_key_id}
DELETE_asm-groups-group_id	admin, delete	DELETE	/asm/groups/{group_id}
DELETE_asm-groups-group_id-suppressions-email	admin, delete	DELETE	/asm/groups/{group_id}/suppressions/{email}
DELETE_asm-suppressions-global-email	delete	DELETE	/asm/suppressions/global/{email}
DELETE_campaigns-campaign_id	delete	DELETE	/campaigns/{campaign_id}
DELETE_campaigns-campaign_id-schedules	delete	DELETE	/campaigns/{campaign_id}/schedules
DELETE_contactdb-custom_fields-custom_field_id	delete	DELETE	/contactdb/custom_fields/{custom_field_id}
DELETE_contactdb-lists-list_id	delete	DELETE	/contactdb/lists/{list_id}
DELETE_contactdb-lists-list_id-recipients-recipient_id	delete	DELETE	/contactdb/lists/{list_id}/recipients/{recipient_id}
DELETE_contactdb-recipients-recipient_id	delete	DELETE	/contactdb/recipients/{recipient_id}
DELETE_contactdb-segments-segment_id	delete	DELETE	/contactdb/segments/{segment_id}
DELETE_ips-pools-pool_name	delete	DELETE	/ips/pools/{pool_name}
DELETE_ips-pools-pool_name-ips-ip	delete	DELETE	/ips/pools/{pool_name}/ips/{ip}
PATCH_mail_settings-address_whitelist	admin, write	PATCH	/mail_settings/address_whitelist
PATCH_mail_settings-footer	admin, write	PATCH	/mail_settings/footer
PATCH_mail_settings-forward_bounce	admin, write	PATCH	/mail_settings/forward_bounce
PATCH_user-scheduled_sends-batch_id	admin, write	PATCH	/user/scheduled_sends/{batch_id}
POST_v3-teammates-pending-token-resend	admin, write	POST	/teammates/pending/{token}/resend
PATCH_contactdb-lists-list_id	write	PATCH	/contactdb/lists/{list_id}
PATCH_contactdb-segments-segment_id	write	PATCH	/contactdb/segments/{segment_id}
PATCH_marketing-singlesends-id	write	PATCH	/marketing/singlesends/{id}
PATCH_v3-senders-sender_id	write	PATCH	/senders/{sender_id}
PATCH_verified_senders-id	write	PATCH	/verified_senders/{id}
POST-sendgrid-pre-built-design	write	POST	/designs/pre-builts/{id}
POST_contactdb-lists-list_id-recipients	write	POST	/contactdb/lists/{list_id}/recipients
POST_contactdb-lists-list_id-recipients-recipient_id	write	POST	/contactdb/lists/{list_id}/recipients/{recipient_id}
GET-sendgrid-pre-built-design	read	GET	/designs/pre-builts/{id}
GET-v3-messages-msg_id	read	GET	/messages/{msg_id}
GET_asm-suppressions-email	read	GET	/asm/suppressions/{email}
GET_asm-suppressions-global-email	read	GET	/asm/suppressions/global/{email}
GET_contactdb-custom_fields-custom_field_id	read	GET	/contactdb/custom_fields/{custom_field_id}
GET_contactdb-lists-list_id	read	GET	/contactdb/lists/{list_id}