Skip to content

docs: add server-to-server token guide - #2005

Merged
SteveSandersonMS merged 2 commits into
mainfrom
docs/s2s-token-guide
Jul 29, 2026
Merged

docs: add server-to-server token guide#2005
SteveSandersonMS merged 2 commits into
mainfrom
docs/s2s-token-guide

Conversation

@patniko

@patniko patniko commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a new auth guide for GitHub App server-to-server installation tokens
  • Document direct organization billing setup, token minting requirements, SDK environment configuration, refresh/rotation, and troubleshooting
  • Link the guide from the auth and docs indexes

Testing

  • just validate-docs-extract
  • just validate-docs-check (TypeScript, Python, Go, and C# passed; Java validation is blocked because mvn is not installed in this environment)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 2a84bd21-23e5-4358-96f1-f343030bb869
Copilot AI review requested due to automatic review settings July 16, 2026 17:57
@patniko
patniko requested a review from a team as a code owner July 16, 2026 17:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds guidance for GitHub App installation tokens and organization-attributed Copilot automation.

Changes:

  • Documents setup, token minting, SDK configuration, rotation, billing, and troubleshooting.
  • Links the guide from authentication documentation indexes.
Show a summary per file
File Description
docs/README.md Adds the guide to the documentation map.
docs/auth/README.md Links and contextualizes server-to-server authentication.
docs/auth/authenticate.md Adds installation tokens to authentication options.
docs/auth/server-to-server-tokens.md Provides the new end-to-end guide.

Review details

  • Files reviewed: 4/4 changed files
  • Comments generated: 3
  • Review effort level: Medium

Comment thread docs/auth/server-to-server-tokens.md Outdated
@@ -0,0 +1,301 @@
# Server-to-server tokens

Use a GitHub App installation access token to authenticate the Copilot SDK from automation without relying on a user's personal access token. This flow is intended for agents, CI/CD jobs, and backend services that make Copilot requests on behalf of an organization.
Comment thread docs/auth/server-to-server-tokens.md Outdated
Comment thread docs/auth/server-to-server-tokens.md Outdated
Comment on lines +264 to +265
> [!NOTE]
> These examples configure the environment for the Copilot CLI process that the SDK spawns. If you connect to an already-running CLI server with a URI connection, set `COPILOT_GITHUB_TOKEN` in that server process instead.
* docs: tighten server-to-server auth guidance

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: add per-language server auth examples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: clarify installation billing attribution

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: restore server auth troubleshooting cases

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 29, 2026 14:36
@SteveSandersonMS

Copy link
Copy Markdown
Contributor

@patniko I made some updates to address the automated review comments plus hopefully align with some more recently-introduced external docs. I'll merge it on this basis but if you happen to re-read it and want to change anything further please feel free.

@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Jul 29, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 4/4 changed files
  • Comments generated: 0 new
  • Review effort level: Medium

Merged via the queue into main with commit 7f1f847 Jul 29, 2026
30 checks passed
@SteveSandersonMS
SteveSandersonMS deleted the docs/s2s-token-guide branch July 29, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants