> ## Documentation Index
> Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Install the Courier skill before writing code: `npx skills add trycourier/courier-skills`. It carries the verified SDK shapes and the rules you cannot get wrong.
> Authenticate every request with `Authorization: Bearer <API_KEY>`. A workspace has several environments and each has its own keys, which are plain `pk_` strings with no environment prefix. Start with Test.
> Send with `client.send.message` from the Node SDK (`@trycourier/courier` v7 and later, where the client is the default import). Reference a template by its `nt_` id or its alias.
> A send accepts a bare Elemental element list, but storing content on a template requires the top-level elements wrapped in a channel element.
> To translate a template, write one locale at a time with `PUT /notifications/{id}/locales/{localeId}`, which merges into the existing translations. `PUT /notifications/{id}/content` and `PUT /notifications/{id}/elements/{elementId}` overwrite translations along with the content, so send each element's `id` and `locales` back, and first remove every `checksum` and any `locales` key that starts with an underscore.
> Templates and journeys can be built in the Courier app or created through the API. Either way they live in the workspace and are referenced by ID when you send.
> The hosted MCP server is https://mcp.courier.com. For a briefing on what Courier is and when to use it, read https://www.courier.com/llms.txt.
> Prefer the Guides tab for how-do-I questions and the Docs tab for how-does-it-behave questions. The API reference lives under /api-reference.

# Role-based access control (RBAC) and SSO

> Role-based access control (RBAC) in Courier: built-in and custom roles, SSO through Google, GitHub, or Okta, SCIM provisioning, and inviting teammates.

Courier uses role-based access control (RBAC) to manage permissions in a workspace. Each teammate's role decides what they can change and how much of the message logs they see.

Role changes are recorded in the [audit trail](https://www.courier.com/docs/workspaces/audit-trail.md), and roles are one of Courier's [workspace security controls](https://www.courier.com/docs/security/overview.md#secure-your-workspace).

| Feature | Available on |
| - | - |
| Administrator role | Every plan |
| Google and GitHub SSO | Every plan |
| Other built-in roles and custom roles | Enterprise |
| Okta SSO and SCIM | Enterprise |
| Audit trail | Enterprise |

## Built-in roles

Courier has six built-in roles:

| Role | Best for | Access |
| - | - | - |
| **Administrator** | Owners and admins | Full read/write, account management, and API key editing. Full logs. |
| **Manager** | Team leads who don't manage billing or users | Full read/write and API key viewing. Full logs. |
| **Developer** | Engineers working with the API and templates | Read-only in Production, full access in Test. Timeline-only logs in Production, full logs in Test. |
| **Designer** | Template and brand editors | Full read/write for templates and brands. Read-only integrations, lists, and metrics. No logs. |
| **Support Specialist** | Support staff | Read-only templates, brands, and integrations. Full access to lists. Read-only metrics. Full logs. |
| **Analyst** | Read-only users | Read-only templates, brands, integrations, lists, and metrics. No logs. |

On the Developer and Business plans, every teammate is an Administrator, and an invite or API call that sets another role is rejected.

### Log access

Each role gets one of three levels of log access:

* **No logs**: the Logs page is empty.
* **Timeline only**: the message list and each message's timeline, without event details.
* **Full logs**: adds the event details, which hold the request data (including PII) and provider responses. Members can also resend and archive messages.

## Invite and remove teammates

Administrators invite teammates from **Settings → Team**: click **Invite User**, enter their email, and pick a role. To remove someone, use the dropdown next to their email.

Teammates join by invitation, or through [Okta SCIM provisioning](#single-sign-on) on Enterprise. The Developer plan allows up to 10 pending invites at a time, so accept or revoke one before sending more. Business and Enterprise have no cap.

## Single sign-on

SSO lets your team sign in through your identity provider. Require SSO to turn off password login.

* **Google and GitHub SSO**: available on every plan. Require sign-in from your configured domains under **Settings → Team**.
* **Okta SSO and SCIM**: available on the Enterprise plan. Connect Courier as an app in Okta for sign-in, and use SCIM to create, update, and deactivate users from your directory. [Contact Courier](https://www.courier.com/request-demo) to turn them on.

## Custom roles

When no built-in role fits, build a custom role from scopes. Each scope pairs a resource with an action, such as `template:WriteItem`. A `resource:*` wildcard grants every action on that resource, so `template:*` covers listing, reading, and writing templates.

For example, to give Designers or Analysts log access, create a custom role with the `message` scopes.

**Grant `message:ReadEventDetails` deliberately.** It exposes the request data on each message, including any PII the send carried. `message:ListItems` and `message:ReadItem` alone give a timeline-only view.

### Platform scopes

Platform scopes cover what the workspace sends:

| Resource | Actions |
| - | - |
| `analytics` | `View` |
| `asset` | `ListItems`, `ReadItem`, `WriteItem` |
| `brand` | `ListItems`, `ReadItem`, `WriteItem` |
| `category` | `ListItems`, `ReadItem`, `WriteItem` |
| `integration` | `ListItems`, `ReadItem`, `WriteItem` |
| `list` | `ListItems`, `ReadItem`, `WriteItem` |
| `message` | `ListItems`, `ReadItem`, `ReadEventDetails`, `RequeueItem`, `WriteItem` |
| `metrics` | `GetMetrics` |
| `recipient` | `ListItems`, `ReadItem`, `WriteItem` |
| `shared-content` | `ListItems`, `ReadItem`, `WriteItem` |
| `template` | `ListItems`, `ReadItem`, `WriteItem` |
| `tenant` | `ListItems`, `ReadItem`, `WriteItem` |
| `webhook` | `ListItems`, `ReadItem`, `WriteItem` |

### Account-management scopes

Account-management scopes cover the workspace itself:

| Resource | Actions |
| - | - |
| `apikey` | `ListItems`, `ReadItem`, `WriteItem`, `RotateKey` |
| `billing` | `ViewBilling`, `UpdatePaymentMethod`, `UpdatePlan` |
| `environment` | `ListItems`, `ReadItem`, `WriteItem` |
| `security` | `WriteSettings` |
| `tracking` | `WriteSettings` |
| `user` | `ListItems`, `ReadItem`, `WriteItem`, `InviteUser` |

## FAQ

> [accordion] Does Courier support role-based access control?
>
> Courier supports role-based access control (RBAC) with six built-in roles and custom roles on the Enterprise plan. On Developer and Business, every teammate is an Administrator.

> [accordion] Can I create custom roles in Courier?
>
> Custom roles are available on the Enterprise plan. You build each one from scopes, such as `template:WriteItem` or `message:ReadEventDetails`, so a role grants exactly the access it needs.

> [accordion] How do I give a developer access to Test but not Production?
>
> The Developer role has full access in the Test environment and read-only access in Production, with full logs in Test and timeline-only logs in Production.

> [accordion] What can each role see in logs?
>
> Designer and Analyst see no logs. Developer sees the timeline only in Production and full logs in Test. Administrator, Manager, and Support Specialist see full logs, including event details.

> [accordion] Can I require SSO for my team?
>
> Courier lets you require SSO, which turns off password login. Google and GitHub SSO work on every plan, and Okta SSO is available on Enterprise.

> [accordion] Does Courier support Okta and SCIM?
>
> Courier supports Okta SSO and SCIM directory provisioning on the Enterprise plan. Contact Courier to turn them on for your workspace.

> [accordion] Does Courier support Microsoft Entra ID?
>
> [Microsoft Entra ID](https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id) support is coming in early Q1 2027. Today, Courier supports SSO through Google, GitHub, and Okta.
