/
team_api_doc.go
37 lines (24 loc) · 1.38 KB
/
team_api_doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package client
const teamAPIDoc = `"keybase team api" provides a JSON API to Keybase teams.
EXAMPLES:
List all your team memberships:
{"method": "list-self-memberships"}
List memberships on one team:
{"method": "list-team-memberships", "params": {"options": {"team": "phoenix"}}}
List memberships for a user:
{"method": "list-user-memberships", "params": {"options": {"username": "cleo"}}}
Create a team:
{"method": "create-team", "params": {"options": {"team": "phoenix"}}}
Add members to a team:
{"method": "add-members", "params": {"options": {"team": "phoenix", "emails": [{"email": "alice@keybase.io", "role": "writer"}, {"email": "cleo@keybase.io", "role": "admin"}], "usernames": [{"username": "frank", "role": "reader"}, {"username": "keybaseio@twitter", "role": "writer"}]}}}
Change a member's role:
{"method": "edit-member", "params": {"options": {"team": "phoenix", "username": "frank", "role": "writer"}}}
Remove a member:
{"method": "remove-member", "params": {"options": {"team": "phoenix", "username": "frank"}}}
Create a subteam:
{"method": "create-team", "params": {"options": {"team": "phoenix.bots"}}}
Rename a subteam:
{"method": "rename-subteam", "params": {"options": {"team": "phoenix.bots", "new-team-name": "phoenix.humans"}}}
Leave a team:
{"method": "leave-team", "params": {"options": {"team": "phoenix.humans", "permanent": true}}}
`