You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

465 lines
14 KiB

  1. {
  2. "auth": {
  3. "oauth2": {
  4. "scopes": {
  5. "https://www.googleapis.com/auth/apps.licensing": {
  6. "description": "View and manage G Suite licenses for your domain"
  7. }
  8. }
  9. }
  10. },
  11. "basePath": "/apps/licensing/v1/product/",
  12. "baseUrl": "https://www.googleapis.com/apps/licensing/v1/product/",
  13. "batchPath": "batch/licensing/v1",
  14. "description": "Views and manages licenses for your domain.",
  15. "discoveryVersion": "v1",
  16. "documentationLink": "https://developers.google.com/google-apps/licensing/",
  17. "etag": "\"Zkyw9ACJZUvcYmlFaKGChzhmtnE/tIOs6izg-EVHX4TTrroawBuzhAM\"",
  18. "icons": {
  19. "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
  20. "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
  21. },
  22. "id": "licensing:v1",
  23. "kind": "discovery#restDescription",
  24. "name": "licensing",
  25. "ownerDomain": "google.com",
  26. "ownerName": "Google",
  27. "parameters": {
  28. "alt": {
  29. "default": "json",
  30. "description": "Data format for the response.",
  31. "enum": [
  32. "json"
  33. ],
  34. "enumDescriptions": [
  35. "Responses with Content-Type of application/json"
  36. ],
  37. "location": "query",
  38. "type": "string"
  39. },
  40. "fields": {
  41. "description": "Selector specifying which fields to include in a partial response.",
  42. "location": "query",
  43. "type": "string"
  44. },
  45. "key": {
  46. "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  47. "location": "query",
  48. "type": "string"
  49. },
  50. "oauth_token": {
  51. "description": "OAuth 2.0 token for the current user.",
  52. "location": "query",
  53. "type": "string"
  54. },
  55. "prettyPrint": {
  56. "default": "true",
  57. "description": "Returns response with indentations and line breaks.",
  58. "location": "query",
  59. "type": "boolean"
  60. },
  61. "quotaUser": {
  62. "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
  63. "location": "query",
  64. "type": "string"
  65. },
  66. "userIp": {
  67. "description": "Deprecated. Please use quotaUser instead.",
  68. "location": "query",
  69. "type": "string"
  70. }
  71. },
  72. "protocol": "rest",
  73. "resources": {
  74. "licenseAssignments": {
  75. "methods": {
  76. "delete": {
  77. "description": "Revoke License.",
  78. "httpMethod": "DELETE",
  79. "id": "licensing.licenseAssignments.delete",
  80. "parameterOrder": [
  81. "productId",
  82. "skuId",
  83. "userId"
  84. ],
  85. "parameters": {
  86. "productId": {
  87. "description": "Name for product",
  88. "location": "path",
  89. "required": true,
  90. "type": "string"
  91. },
  92. "skuId": {
  93. "description": "Name for sku",
  94. "location": "path",
  95. "required": true,
  96. "type": "string"
  97. },
  98. "userId": {
  99. "description": "email id or unique Id of the user",
  100. "location": "path",
  101. "required": true,
  102. "type": "string"
  103. }
  104. },
  105. "path": "{productId}/sku/{skuId}/user/{userId}",
  106. "scopes": [
  107. "https://www.googleapis.com/auth/apps.licensing"
  108. ]
  109. },
  110. "get": {
  111. "description": "Get license assignment of a particular product and sku for a user",
  112. "httpMethod": "GET",
  113. "id": "licensing.licenseAssignments.get",
  114. "parameterOrder": [
  115. "productId",
  116. "skuId",
  117. "userId"
  118. ],
  119. "parameters": {
  120. "productId": {
  121. "description": "Name for product",
  122. "location": "path",
  123. "required": true,
  124. "type": "string"
  125. },
  126. "skuId": {
  127. "description": "Name for sku",
  128. "location": "path",
  129. "required": true,
  130. "type": "string"
  131. },
  132. "userId": {
  133. "description": "email id or unique Id of the user",
  134. "location": "path",
  135. "required": true,
  136. "type": "string"
  137. }
  138. },
  139. "path": "{productId}/sku/{skuId}/user/{userId}",
  140. "response": {
  141. "$ref": "LicenseAssignment"
  142. },
  143. "scopes": [
  144. "https://www.googleapis.com/auth/apps.licensing"
  145. ]
  146. },
  147. "insert": {
  148. "description": "Assign License.",
  149. "httpMethod": "POST",
  150. "id": "licensing.licenseAssignments.insert",
  151. "parameterOrder": [
  152. "productId",
  153. "skuId"
  154. ],
  155. "parameters": {
  156. "productId": {
  157. "description": "Name for product",
  158. "location": "path",
  159. "required": true,
  160. "type": "string"
  161. },
  162. "skuId": {
  163. "description": "Name for sku",
  164. "location": "path",
  165. "required": true,
  166. "type": "string"
  167. }
  168. },
  169. "path": "{productId}/sku/{skuId}/user",
  170. "request": {
  171. "$ref": "LicenseAssignmentInsert"
  172. },
  173. "response": {
  174. "$ref": "LicenseAssignment"
  175. },
  176. "scopes": [
  177. "https://www.googleapis.com/auth/apps.licensing"
  178. ]
  179. },
  180. "listForProduct": {
  181. "description": "List license assignments for given product of the customer.",
  182. "httpMethod": "GET",
  183. "id": "licensing.licenseAssignments.listForProduct",
  184. "parameterOrder": [
  185. "productId",
  186. "customerId"
  187. ],
  188. "parameters": {
  189. "customerId": {
  190. "description": "CustomerId represents the customer for whom licenseassignments are queried",
  191. "location": "query",
  192. "required": true,
  193. "type": "string"
  194. },
  195. "maxResults": {
  196. "default": "100",
  197. "description": "Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.",
  198. "format": "uint32",
  199. "location": "query",
  200. "maximum": "1000",
  201. "minimum": "1",
  202. "type": "integer"
  203. },
  204. "pageToken": {
  205. "default": "",
  206. "description": "Token to fetch the next page.Optional. By default server will return first page",
  207. "location": "query",
  208. "type": "string"
  209. },
  210. "productId": {
  211. "description": "Name for product",
  212. "location": "path",
  213. "required": true,
  214. "type": "string"
  215. }
  216. },
  217. "path": "{productId}/users",
  218. "response": {
  219. "$ref": "LicenseAssignmentList"
  220. },
  221. "scopes": [
  222. "https://www.googleapis.com/auth/apps.licensing"
  223. ]
  224. },
  225. "listForProductAndSku": {
  226. "description": "List license assignments for given product and sku of the customer.",
  227. "httpMethod": "GET",
  228. "id": "licensing.licenseAssignments.listForProductAndSku",
  229. "parameterOrder": [
  230. "productId",
  231. "skuId",
  232. "customerId"
  233. ],
  234. "parameters": {
  235. "customerId": {
  236. "description": "CustomerId represents the customer for whom licenseassignments are queried",
  237. "location": "query",
  238. "required": true,
  239. "type": "string"
  240. },
  241. "maxResults": {
  242. "default": "100",
  243. "description": "Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.",
  244. "format": "uint32",
  245. "location": "query",
  246. "maximum": "1000",
  247. "minimum": "1",
  248. "type": "integer"
  249. },
  250. "pageToken": {
  251. "default": "",
  252. "description": "Token to fetch the next page.Optional. By default server will return first page",
  253. "location": "query",
  254. "type": "string"
  255. },
  256. "productId": {
  257. "description": "Name for product",
  258. "location": "path",
  259. "required": true,
  260. "type": "string"
  261. },
  262. "skuId": {
  263. "description": "Name for sku",
  264. "location": "path",
  265. "required": true,
  266. "type": "string"
  267. }
  268. },
  269. "path": "{productId}/sku/{skuId}/users",
  270. "response": {
  271. "$ref": "LicenseAssignmentList"
  272. },
  273. "scopes": [
  274. "https://www.googleapis.com/auth/apps.licensing"
  275. ]
  276. },
  277. "patch": {
  278. "description": "Assign License. This method supports patch semantics.",
  279. "httpMethod": "PATCH",
  280. "id": "licensing.licenseAssignments.patch",
  281. "parameterOrder": [
  282. "productId",
  283. "skuId",
  284. "userId"
  285. ],
  286. "parameters": {
  287. "productId": {
  288. "description": "Name for product",
  289. "location": "path",
  290. "required": true,
  291. "type": "string"
  292. },
  293. "skuId": {
  294. "description": "Name for sku for which license would be revoked",
  295. "location": "path",
  296. "required": true,
  297. "type": "string"
  298. },
  299. "userId": {
  300. "description": "email id or unique Id of the user",
  301. "location": "path",
  302. "required": true,
  303. "type": "string"
  304. }
  305. },
  306. "path": "{productId}/sku/{skuId}/user/{userId}",
  307. "request": {
  308. "$ref": "LicenseAssignment"
  309. },
  310. "response": {
  311. "$ref": "LicenseAssignment"
  312. },
  313. "scopes": [
  314. "https://www.googleapis.com/auth/apps.licensing"
  315. ]
  316. },
  317. "update": {
  318. "description": "Assign License.",
  319. "httpMethod": "PUT",
  320. "id": "licensing.licenseAssignments.update",
  321. "parameterOrder": [
  322. "productId",
  323. "skuId",
  324. "userId"
  325. ],
  326. "parameters": {
  327. "productId": {
  328. "description": "Name for product",
  329. "location": "path",
  330. "required": true,
  331. "type": "string"
  332. },
  333. "skuId": {
  334. "description": "Name for sku for which license would be revoked",
  335. "location": "path",
  336. "required": true,
  337. "type": "string"
  338. },
  339. "userId": {
  340. "description": "email id or unique Id of the user",
  341. "location": "path",
  342. "required": true,
  343. "type": "string"
  344. }
  345. },
  346. "path": "{productId}/sku/{skuId}/user/{userId}",
  347. "request": {
  348. "$ref": "LicenseAssignment"
  349. },
  350. "response": {
  351. "$ref": "LicenseAssignment"
  352. },
  353. "scopes": [
  354. "https://www.googleapis.com/auth/apps.licensing"
  355. ]
  356. }
  357. }
  358. }
  359. },
  360. "revision": "20170213",
  361. "rootUrl": "https://www.googleapis.com/",
  362. "schemas": {
  363. "LicenseAssignment": {
  364. "description": "Template for LiscenseAssignment Resource",
  365. "id": "LicenseAssignment",
  366. "properties": {
  367. "etags": {
  368. "description": "ETag of the resource.",
  369. "type": "string"
  370. },
  371. "kind": {
  372. "default": "licensing#licenseAssignment",
  373. "description": "Identifies the resource as a LicenseAssignment.",
  374. "type": "string"
  375. },
  376. "productId": {
  377. "annotations": {
  378. "required": [
  379. "licensing.licenseAssignments.update"
  380. ]
  381. },
  382. "description": "Id of the product.",
  383. "type": "string"
  384. },
  385. "productName": {
  386. "description": "Display Name of the product.",
  387. "type": "string"
  388. },
  389. "selfLink": {
  390. "description": "Link to this page.",
  391. "type": "string"
  392. },
  393. "skuId": {
  394. "annotations": {
  395. "required": [
  396. "licensing.licenseAssignments.update"
  397. ]
  398. },
  399. "description": "Id of the sku of the product.",
  400. "type": "string"
  401. },
  402. "skuName": {
  403. "description": "Display Name of the sku of the product.",
  404. "type": "string"
  405. },
  406. "userId": {
  407. "annotations": {
  408. "required": [
  409. "licensing.licenseAssignments.update"
  410. ]
  411. },
  412. "description": "Email id of the user.",
  413. "type": "string"
  414. }
  415. },
  416. "type": "object"
  417. },
  418. "LicenseAssignmentInsert": {
  419. "description": "Template for LicenseAssignment Insert request",
  420. "id": "LicenseAssignmentInsert",
  421. "properties": {
  422. "userId": {
  423. "annotations": {
  424. "required": [
  425. "licensing.licenseAssignments.insert"
  426. ]
  427. },
  428. "description": "Email id of the user",
  429. "type": "string"
  430. }
  431. },
  432. "type": "object"
  433. },
  434. "LicenseAssignmentList": {
  435. "description": "LicesnseAssignment List for a given product/sku for a customer.",
  436. "id": "LicenseAssignmentList",
  437. "properties": {
  438. "etag": {
  439. "description": "ETag of the resource.",
  440. "type": "string"
  441. },
  442. "items": {
  443. "description": "The LicenseAssignments in this page of results.",
  444. "items": {
  445. "$ref": "LicenseAssignment"
  446. },
  447. "type": "array"
  448. },
  449. "kind": {
  450. "default": "licensing#licenseAssignmentList",
  451. "description": "Identifies the resource as a collection of LicenseAssignments.",
  452. "type": "string"
  453. },
  454. "nextPageToken": {
  455. "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
  456. "type": "string"
  457. }
  458. },
  459. "type": "object"
  460. }
  461. },
  462. "servicePath": "apps/licensing/v1/product/",
  463. "title": "Enterprise License Manager API",
  464. "version": "v1"
  465. }