Skip to content

Commit af552dc

Browse files
committed
explain team and OAuth scoping
1 parent 1f4ba5b commit af552dc

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

install/index.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ The streamable HTTP endpoint is available at `https://api.ref.tools/mcp`.
1919

2020
You can find your API key at [ref.tools/keys](https://ref.tools/keys)
2121

22+
### OAuth and Teams
23+
24+
If you use OAuth in combination with [Teams](/usage/teams), you may need to specify the team you want Ref to access. Ref will do it's best to intelligently pick the correct team but you may want to manually force a specific team.
25+
26+
Here is the algorithm Ref uses to pick the user or team scope:
27+
```
28+
For base OAuth url https://api.ref.tools/mcp if the user belongs to:
29+
- no teams -> user scope
30+
- one team -> team scope for the users single team
31+
- multiple teams -> user scope, require specifying team
32+
33+
When specifying scope in OAuth url https://api.ref.tools/mcp?scope=(user|{team_id})
34+
- scope=user -> user scope
35+
- scope={team_id} -> team scope
36+
```
37+
38+
Team ids have the format `t-<hash>`. You can find the team OAuth url at [ref.tools/install](https://ref.tools/install)
39+
2240
---
2341

2442
## Installation Guides

0 commit comments

Comments
 (0)