513 lines
20 KiB
JSON
513 lines
20 KiB
JSON
|
{
|
||
|
|
"auth": {
|
||
|
|
"oauth2": {
|
||
|
|
"scopes": {
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing": {
|
||
|
|
"description": "View and manage G Suite licenses for your domain"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"basePath": "",
|
||
|
|
"baseUrl": "https://licensing.googleapis.com/",
|
||
|
|
"batchPath": "batch",
|
||
|
|
"description": "The Google Enterprise License Manager API's allows you to license apps for all the users of a domain managed by you.",
|
||
|
|
"discoveryVersion": "v1",
|
||
|
|
"documentationLink": "https://developers.google.com/admin-sdk/licensing/",
|
||
|
|
"fullyEncodeReservedExpansion": true,
|
||
|
|
"icons": {
|
||
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||
|
|
},
|
||
|
|
"id": "licensing:v1",
|
||
|
|
"kind": "discovery#restDescription",
|
||
|
|
"mtlsRootUrl": "https://licensing.mtls.googleapis.com/",
|
||
|
|
"name": "licensing",
|
||
|
|
"ownerDomain": "google.com",
|
||
|
|
"ownerName": "Google",
|
||
|
|
"parameters": {
|
||
|
|
"$.xgafv": {
|
||
|
|
"description": "V1 error format.",
|
||
|
|
"enum": [
|
||
|
|
"1",
|
||
|
|
"2"
|
||
|
|
],
|
||
|
|
"enumDescriptions": [
|
||
|
|
"v1 error format",
|
||
|
|
"v2 error format"
|
||
|
|
],
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"access_token": {
|
||
|
|
"description": "OAuth access token.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"alt": {
|
||
|
|
"default": "json",
|
||
|
|
"description": "Data format for response.",
|
||
|
|
"enum": [
|
||
|
|
"json",
|
||
|
|
"media",
|
||
|
|
"proto"
|
||
|
|
],
|
||
|
|
"enumDescriptions": [
|
||
|
|
"Responses with Content-Type of application/json",
|
||
|
|
"Media download with context-dependent Content-Type",
|
||
|
|
"Responses with Content-Type of application/x-protobuf"
|
||
|
|
],
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"callback": {
|
||
|
|
"description": "JSONP",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"fields": {
|
||
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"key": {
|
||
|
|
"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.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"oauth_token": {
|
||
|
|
"description": "OAuth 2.0 token for the current user.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"prettyPrint": {
|
||
|
|
"default": "true",
|
||
|
|
"description": "Returns response with indentations and line breaks.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"quotaUser": {
|
||
|
|
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"uploadType": {
|
||
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"upload_protocol": {
|
||
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"protocol": "rest",
|
||
|
|
"resources": {
|
||
|
|
"licenseAssignments": {
|
||
|
|
"methods": {
|
||
|
|
"delete": {
|
||
|
|
"description": "Revoke a license.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"httpMethod": "DELETE",
|
||
|
|
"id": "licensing.licenseAssignments.delete",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId",
|
||
|
|
"userId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"userId": {
|
||
|
|
"description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"response": {
|
||
|
|
"$ref": "Empty"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"get": {
|
||
|
|
"description": "Get a specific user's license by product SKU.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"httpMethod": "GET",
|
||
|
|
"id": "licensing.licenseAssignments.get",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId",
|
||
|
|
"userId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"userId": {
|
||
|
|
"description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"insert": {
|
||
|
|
"description": "Assign a license.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/user",
|
||
|
|
"httpMethod": "POST",
|
||
|
|
"id": "licensing.licenseAssignments.insert",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user",
|
||
|
|
"request": {
|
||
|
|
"$ref": "LicenseAssignmentInsert"
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"listForProduct": {
|
||
|
|
"description": "List all users assigned licenses for a specific product SKU.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/users",
|
||
|
|
"httpMethod": "GET",
|
||
|
|
"id": "licensing.licenseAssignments.listForProduct",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"customerId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"customerId": {
|
||
|
|
"description": "Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.",
|
||
|
|
"location": "query",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"maxResults": {
|
||
|
|
"default": "100",
|
||
|
|
"description": "The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.",
|
||
|
|
"format": "uint32",
|
||
|
|
"location": "query",
|
||
|
|
"maximum": "1000",
|
||
|
|
"minimum": "1",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"pageToken": {
|
||
|
|
"default": "",
|
||
|
|
"description": "Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/users",
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignmentList"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"listForProductAndSku": {
|
||
|
|
"description": "List all users assigned licenses for a specific product SKU.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/users",
|
||
|
|
"httpMethod": "GET",
|
||
|
|
"id": "licensing.licenseAssignments.listForProductAndSku",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId",
|
||
|
|
"customerId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"customerId": {
|
||
|
|
"description": "Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.",
|
||
|
|
"location": "query",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"maxResults": {
|
||
|
|
"default": "100",
|
||
|
|
"description": "The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.",
|
||
|
|
"format": "uint32",
|
||
|
|
"location": "query",
|
||
|
|
"maximum": "1000",
|
||
|
|
"minimum": "1",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"pageToken": {
|
||
|
|
"default": "",
|
||
|
|
"description": "Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.",
|
||
|
|
"location": "query",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/users",
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignmentList"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"patch": {
|
||
|
|
"description": "Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"httpMethod": "PATCH",
|
||
|
|
"id": "licensing.licenseAssignments.patch",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId",
|
||
|
|
"userId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"userId": {
|
||
|
|
"description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"request": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"update": {
|
||
|
|
"description": "Reassign a user's product SKU with a different SKU in the same product.",
|
||
|
|
"flatPath": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"httpMethod": "PUT",
|
||
|
|
"id": "licensing.licenseAssignments.update",
|
||
|
|
"parameterOrder": [
|
||
|
|
"productId",
|
||
|
|
"skuId",
|
||
|
|
"userId"
|
||
|
|
],
|
||
|
|
"parameters": {
|
||
|
|
"productId": {
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"userId": {
|
||
|
|
"description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.",
|
||
|
|
"location": "path",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}",
|
||
|
|
"request": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"scopes": [
|
||
|
|
"https://www.googleapis.com/auth/apps.licensing"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"revision": "20211220",
|
||
|
|
"rootUrl": "https://licensing.googleapis.com/",
|
||
|
|
"schemas": {
|
||
|
|
"Empty": {
|
||
|
|
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
|
||
|
|
"id": "Empty",
|
||
|
|
"properties": {},
|
||
|
|
"type": "object"
|
||
|
|
},
|
||
|
|
"LicenseAssignment": {
|
||
|
|
"description": "Representation of a license assignment.",
|
||
|
|
"id": "LicenseAssignment",
|
||
|
|
"properties": {
|
||
|
|
"etags": {
|
||
|
|
"description": "ETag of the resource.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"kind": {
|
||
|
|
"default": "licensing#licenseAssignment",
|
||
|
|
"description": "Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"productId": {
|
||
|
|
"annotations": {
|
||
|
|
"required": [
|
||
|
|
"licensing.licenseAssignments.update"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"description": "A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"productName": {
|
||
|
|
"description": "Display Name of the product.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"selfLink": {
|
||
|
|
"description": "Link to this page.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuId": {
|
||
|
|
"annotations": {
|
||
|
|
"required": [
|
||
|
|
"licensing.licenseAssignments.update"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"description": "A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"skuName": {
|
||
|
|
"description": "Display Name of the sku of the product.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"userId": {
|
||
|
|
"annotations": {
|
||
|
|
"required": [
|
||
|
|
"licensing.licenseAssignments.update"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"type": "object"
|
||
|
|
},
|
||
|
|
"LicenseAssignmentInsert": {
|
||
|
|
"description": "Representation of a license assignment.",
|
||
|
|
"id": "LicenseAssignmentInsert",
|
||
|
|
"properties": {
|
||
|
|
"userId": {
|
||
|
|
"annotations": {
|
||
|
|
"required": [
|
||
|
|
"licensing.licenseAssignments.insert"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"description": "Email id of the user",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"type": "object"
|
||
|
|
},
|
||
|
|
"LicenseAssignmentList": {
|
||
|
|
"id": "LicenseAssignmentList",
|
||
|
|
"properties": {
|
||
|
|
"etag": {
|
||
|
|
"description": "ETag of the resource.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"items": {
|
||
|
|
"description": "The LicenseAssignments in this page of results.",
|
||
|
|
"items": {
|
||
|
|
"$ref": "LicenseAssignment"
|
||
|
|
},
|
||
|
|
"type": "array"
|
||
|
|
},
|
||
|
|
"kind": {
|
||
|
|
"default": "licensing#licenseAssignmentList",
|
||
|
|
"description": "Identifies the resource as a collection of LicenseAssignments.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"nextPageToken": {
|
||
|
|
"description": "The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The `maxResults` query string is related to the `nextPageToken` since `maxResults` determines how many entries are returned on each next page.",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"type": "object"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"servicePath": "",
|
||
|
|
"title": "Enterprise License Manager API",
|
||
|
|
"version": "v1"
|
||
|
|
}
|