This repository has been archived by the owner on Sep 5, 2017. It is now read-only.
forked from orgmanager/orgmanager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
147 lines (107 loc) · 3.34 KB
/
apiary.apib
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
FORMAT: 1A
HOST: https://orgmanager.miguelpiedrafita.com/api
# Orgmanager API
The Orgmanager API allows you to integrate Orgmanager with other applications and projects.
## Getting your token
To get your API token, go to the developers page of your orgmanager installation (http://orgmanager-installation.com/developers)
## User Data [/user]
### Get user info [GET]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 200 (application/json)
{
"id":1,
"name":"Miguel Piedrafita",
"email":"[email protected]",
"github_username":"m1guelpf",
"created_at":"2017-01-25 18:44:32",
"updated_at":"2017-02-16 19:40:50"
}
## User Organizations [/user/orgs]
### Get user organizations [GET]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 200 (application/json)
{
"id":1,
"name":"Test Organization",
"url":"https:\/\/api.github.com\/orgs\/test-org",
"description":null,
"avatar":"https:\/\/miguelpiedrafita.com\/logo.png",
"invitecount":100
}
## Organizations [/org/{id}]
### Get organization info [GET]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 200 (application/json)
{
"id": 1,
"name": "Test Org",
"url": "https://api.github.com/orgs/test-org",
"description": null,
"avatar": "https://avatars.githubusercontent.com/1",
"invitecount": 0
}
### Change organization password [POST]
+ Request
{
"password": "{newpassword}"
}
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 200 (application/json)
{
"id": 1,
"name": "Test Org",
"url": "https://api.github.com/orgs/test-org",
"description": null,
"avatar": "https://avatars.githubusercontent.com/1",
"invitecount": 0,
"password": "{newpassword}"
}
### Update organization [PUT]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 204 (text/html; charset=UTF-8)
### Delete organization [DELETE]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 204 (text/html; charset=UTF-8)
## Join [/join/{id}]
### Join organization [POST]
+ Request
{
"username": "{github_username}"
}
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 204 (text/html; charset=UTF-8)
## Token [/token/regenerate]
### Regenerate Token [GET]
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
Authorization: bearer {token}
+ Response 200 (application/json)
"{newtoken}"