License management
This section contains license management proto files.
Notes:
- To download Gatekeeper proto files, click download Gatekeeper proto files.
- Default values are determined by the gRPC specification. For more information, go to protocol buffers language guide .
license_service.proto
LicenseManager
This service allows managing the license of the product.
gRPC method definitions
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| UploadLicense | UploadLicense Request |
UploadLicense Response |
Uploads a new license (or updates an existing one). |
| DownloadLicense | DownloadLicense Request |
DownloadLicense Response |
Downloads a previously uploaded license. |
Methods with HTTP bindings
Notes:
-
REST API responses use the camel case naming convention, such as gkPersonId, but the REST API requests can either use the camel case or snake case naming convention, such as gk_person_id.
-
The following example displays root prefix and endpoint to build a complete URL, such as
https://gatekeeper.api.nuance.com/v1/audios/upload-url:- Root prefix for API:
https://gatekeeper.api.nuance.com - Endpoint:
/v1/audios/upload-url
To know more about root prefixes for API that can be used for different geographies, go to Sites.
- Root prefix for API:
UploadLicense
DownloadLicense
license_messages.proto
DownloadLicenseRequest
Input message that defines parameters for DownloadLicense.
| Field | Type | Description |
|---|---|---|
| context | nuance.biosec.v1.Context | Mandatory. General request context. |
| version | google.protobuf.Int32Value | Optional. Specify the license version. If missing, default version is used. |
DownloadLicenseResponse
Output message that defines parameters returned by DownloadLicense.
| Field | Type | Description |
|---|---|---|
| status | nuance.rpc.Status | General operation status. |
| buffer | bytes | License data, opaque, previously uploaded via UploadLicense. |
UploadLicenseRequest
Input message that defines parameters for UploadLicense.
| Field | Type | Description |
|---|---|---|
| context | nuance.biosec.v1.Context | Mandatory. General request context. |
| buffer | bytes | Mandatory. The License data, opaque, provided by Nuance. |
| version | google.protobuf.Int32Value | Optional. Specify the license version. If missing, default version is used. |
UploadLicenseResponse
Output message that defines parameters returned by UploadLicense.
| Field | Type | Description |
|---|---|---|
| status | nuance.rpc.Status | General operation status. |