details.json 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  1. {
  2. "get": {
  3. "tags": ["Organizations"],
  4. "description": "Return details on an individual organization including various details such as membership access, features, and teams.",
  5. "operationId": "Retrieve an Organization",
  6. "parameters": [
  7. {
  8. "name": "organization_id_or_slug",
  9. "in": "path",
  10. "description": "The id or slug of the organization to look up.",
  11. "required": true,
  12. "schema": {
  13. "type": "string"
  14. }
  15. }
  16. ],
  17. "responses": {
  18. "200": {
  19. "description": "Success",
  20. "content": {
  21. "application/json": {
  22. "schema": {
  23. "$ref": "../../components/schemas/organization-details.json#/OrganizationDetails"
  24. },
  25. "example": {
  26. "access": [],
  27. "allowSharedIssues": true,
  28. "availableRoles": [
  29. {
  30. "id": "member",
  31. "name": "Member"
  32. },
  33. {
  34. "id": "admin",
  35. "name": "Admin"
  36. },
  37. {
  38. "id": "manager",
  39. "name": "Manager"
  40. },
  41. {
  42. "id": "owner",
  43. "name": "Owner"
  44. }
  45. ],
  46. "avatar": {
  47. "avatarType": "letter_avatar",
  48. "avatarUuid": null
  49. },
  50. "dataScrubber": false,
  51. "dataScrubberDefaults": false,
  52. "dateCreated": "2018-11-06T21:19:55.101Z",
  53. "defaultRole": "member",
  54. "enhancedPrivacy": false,
  55. "experiments": {},
  56. "features": [
  57. "new-teams",
  58. "shared-issues",
  59. "new-issue-ui",
  60. "repos",
  61. "open-membership",
  62. "invite-members",
  63. "sso-saml2",
  64. "sso-basic",
  65. "suggested-commits"
  66. ],
  67. "id": "2",
  68. "isDefault": false,
  69. "isEarlyAdopter": false,
  70. "name": "The Interstellar Jurisdiction",
  71. "onboardingTasks": [
  72. {
  73. "data": {},
  74. "dateCompleted": "2018-11-06T21:20:08.089Z",
  75. "status": "complete",
  76. "task": 1,
  77. "user": ""
  78. }
  79. ],
  80. "openMembership": true,
  81. "pendingAccessRequests": 0,
  82. "projects": [
  83. {
  84. "dateCreated": "2018-11-06T21:19:58.536Z",
  85. "firstEvent": null,
  86. "hasAccess": true,
  87. "id": "3",
  88. "isBookmarked": false,
  89. "isMember": true,
  90. "latestDeploys": null,
  91. "name": "Prime Mover",
  92. "platform": null,
  93. "platforms": [],
  94. "slug": "prime-mover",
  95. "team": {
  96. "id": "2",
  97. "name": "Powerful Abolitionist",
  98. "slug": "powerful-abolitionist"
  99. },
  100. "teams": [
  101. {
  102. "id": "2",
  103. "name": "Powerful Abolitionist",
  104. "slug": "powerful-abolitionist"
  105. }
  106. ]
  107. },
  108. {
  109. "dateCreated": "2018-11-06T21:19:55.121Z",
  110. "firstEvent": null,
  111. "hasAccess": true,
  112. "id": "2",
  113. "isBookmarked": false,
  114. "isMember": true,
  115. "latestDeploys": null,
  116. "name": "Pump Station",
  117. "platform": null,
  118. "platforms": [],
  119. "slug": "pump-station",
  120. "team": {
  121. "id": "2",
  122. "name": "Powerful Abolitionist",
  123. "slug": "powerful-abolitionist"
  124. },
  125. "teams": [
  126. {
  127. "id": "2",
  128. "name": "Powerful Abolitionist",
  129. "slug": "powerful-abolitionist"
  130. }
  131. ]
  132. },
  133. {
  134. "dateCreated": "2018-11-06T21:20:08.064Z",
  135. "firstEvent": null,
  136. "hasAccess": true,
  137. "id": "4",
  138. "isBookmarked": false,
  139. "isMember": true,
  140. "latestDeploys": null,
  141. "name": "The Spoiled Yoghurt",
  142. "platform": null,
  143. "platforms": [],
  144. "slug": "the-spoiled-yoghurt",
  145. "team": {
  146. "id": "2",
  147. "name": "Powerful Abolitionist",
  148. "slug": "powerful-abolitionist"
  149. },
  150. "teams": [
  151. {
  152. "id": "2",
  153. "name": "Powerful Abolitionist",
  154. "slug": "powerful-abolitionist"
  155. }
  156. ]
  157. }
  158. ],
  159. "quota": {
  160. "accountLimit": 0,
  161. "maxRate": 0,
  162. "maxRateInterval": 60,
  163. "projectLimit": 100
  164. },
  165. "require2FA": false,
  166. "safeFields": [],
  167. "scrapeJavaScript": true,
  168. "scrubIPAddresses": false,
  169. "sensitiveFields": [],
  170. "slug": "the-interstellar-jurisdiction",
  171. "status": {
  172. "id": "active",
  173. "name": "active"
  174. },
  175. "storeCrashReports": 0,
  176. "teams": [
  177. {
  178. "avatar": {
  179. "avatarType": "letter_avatar",
  180. "avatarUuid": null
  181. },
  182. "dateCreated": "2018-11-06T21:20:08.115Z",
  183. "hasAccess": true,
  184. "id": "3",
  185. "isMember": true,
  186. "isPending": false,
  187. "memberCount": 1,
  188. "name": "Ancient Gabelers",
  189. "slug": "ancient-gabelers"
  190. },
  191. {
  192. "avatar": {
  193. "avatarType": "letter_avatar",
  194. "avatarUuid": null
  195. },
  196. "dateCreated": "2018-11-06T21:19:55.114Z",
  197. "hasAccess": true,
  198. "id": "2",
  199. "isMember": true,
  200. "isPending": false,
  201. "memberCount": 1,
  202. "name": "Powerful Abolitionist",
  203. "slug": "powerful-abolitionist"
  204. }
  205. ],
  206. "trustedRelays": []
  207. }
  208. }
  209. }
  210. },
  211. "403": {
  212. "description": "Forbidden"
  213. },
  214. "404": {
  215. "description": "The requested resource does not exist"
  216. },
  217. "401": {
  218. "description": "Unauthorized"
  219. }
  220. },
  221. "security": [
  222. {
  223. "auth_token": ["org: read"]
  224. }
  225. ]
  226. },
  227. "put": {
  228. "tags": ["Organizations"],
  229. "description": "Update various attributes and configurable settings for the given organization.",
  230. "operationId": "Update an Organization",
  231. "parameters": [
  232. {
  233. "name": "organization_id_or_slug",
  234. "in": "path",
  235. "description": "The id or slug of the organization to update.",
  236. "required": true,
  237. "schema": {
  238. "type": "string"
  239. }
  240. }
  241. ],
  242. "requestBody": {
  243. "content": {
  244. "application/json": {
  245. "schema": {
  246. "required": ["name"],
  247. "type": "object",
  248. "properties": {
  249. "name": {
  250. "type": "string",
  251. "description": "An optional new name for the organization."
  252. },
  253. "slug": {
  254. "type": "string",
  255. "description": "An optional new slug for the organization. Needs to be available and unique."
  256. }
  257. }
  258. },
  259. "example": {
  260. "name": "Impeccably Designated",
  261. "slug": "impeccably-designated"
  262. }
  263. }
  264. },
  265. "required": false
  266. },
  267. "responses": {
  268. "200": {
  269. "description": "Success",
  270. "content": {
  271. "application/json": {
  272. "schema": {
  273. "$ref": "../../components/schemas/organization-details.json#/OrganizationDetails"
  274. },
  275. "example": {
  276. "access": [],
  277. "allowSharedIssues": true,
  278. "availableRoles": [
  279. {
  280. "id": "member",
  281. "name": "Member"
  282. },
  283. {
  284. "id": "admin",
  285. "name": "Admin"
  286. },
  287. {
  288. "id": "manager",
  289. "name": "Manager"
  290. },
  291. {
  292. "id": "owner",
  293. "name": "Owner"
  294. }
  295. ],
  296. "avatar": {
  297. "avatarType": "letter_avatar",
  298. "avatarUuid": null
  299. },
  300. "dataScrubber": false,
  301. "dataScrubberDefaults": false,
  302. "dateCreated": "2018-11-06T21:20:19.548Z",
  303. "defaultRole": "member",
  304. "enhancedPrivacy": false,
  305. "experiments": {},
  306. "features": [
  307. "new-teams",
  308. "shared-issues",
  309. "new-issue-ui",
  310. "repos",
  311. "open-membership",
  312. "invite-members",
  313. "sso-saml2",
  314. "sso-basic",
  315. "suggested-commits"
  316. ],
  317. "id": "3",
  318. "isDefault": false,
  319. "isEarlyAdopter": false,
  320. "name": "Impeccably Designated",
  321. "onboardingTasks": [],
  322. "openMembership": true,
  323. "pendingAccessRequests": 0,
  324. "projects": [],
  325. "quota": {
  326. "accountLimit": 0,
  327. "maxRate": 0,
  328. "maxRateInterval": 60,
  329. "projectLimit": 100
  330. },
  331. "require2FA": false,
  332. "safeFields": [],
  333. "scrapeJavaScript": true,
  334. "scrubIPAddresses": false,
  335. "sensitiveFields": [],
  336. "slug": "impeccably-designated",
  337. "status": {
  338. "id": "active",
  339. "name": "active"
  340. },
  341. "storeCrashReports": 0,
  342. "teams": [],
  343. "trustedRelays": []
  344. }
  345. }
  346. }
  347. },
  348. "403": {
  349. "description": "Forbidden"
  350. },
  351. "401": {
  352. "description": "Unauthorized"
  353. },
  354. "404": {
  355. "description": "Not Found"
  356. },
  357. "400": {
  358. "description": "Bad Input"
  359. }
  360. },
  361. "security": [
  362. {
  363. "auth_token": ["org:write"]
  364. }
  365. ]
  366. }
  367. }