Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nfon licenses API

Unified license management operations

Nfon licenses API is one of 52 APIs that Nfon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include licenses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 2.0-early-access.

Requests are made against a single base URL, https://api.nfon.com/call-history.

8 operations 6 paths 22 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0-early-access
Base URL
https://api.nfon.net/configuration/v1
Authentication
HTTP Bearer
Contact
License
NFON proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Nfon licenses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • bearer_auth — JSON Web Token

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

licenses 8

Unified license management operations

GET
/tenants/{tenant}/users/{userid}/licenses
Get licenses assigned to the authenticated user
getUserLicenses 2 params → 404400401200503403500
GET
/license-types
Get all available license types
getLicenseTypes 1 param → 200503400500
POST
/tenants/{tenant}/licenses
Create licenses for a tenant
createTenantLicenses 2 params body → 404500400401503409403201
DELETE
/tenants/{tenant}/licenses
Delete licenses for a tenant
deleteTenantLicenses 2 params → 207500200503400
GET
/tenants/{tenant}/licenses
Retrieve licenses for a tenant
getTenantLicenses 6 params → 200503500404
POST
/tenants/{tenant}/licenses/assign
Assign licenses to users or extensions
assignLicenses 1 param body → 207503400401200500402404
POST
/tenants/{tenant}/licenses/unassign
Unassign licenses
unassignLicenses 1 param body → 207500200503400
GET
/tenants/{tenant}/licenses/usage
Get license usage for a tenant
getTenantLicenseUsage 1 param → 200503500404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are LicenseDetail (8 properties), LicenseTypeMetadata (6 properties), LicenseElement (6 properties), LicenseAssignResult (6 properties). Each schema is shown below with its type and property counts.

LicenseOperationsResponse
object
LicenseAssignResponse represents the response after assigning licenses. This is named LicenseOperationsResponse in the OpenAPI spec.
4 properties
LicenseDetails
array
LicenseDetails is an array of license details.
LicenseOperation
object
LicenseOperation represents a single license operation.
4 properties 1 required
LicenseTypeMetadata
object
LicenseTypeMetadata represents detailed metadata about a license type.
6 properties
LicenseUnassignRequest
object
LicenseUnassignRequest represents the request body for unassigning licenses.
1 property 1 required
LicenseElement
object
LicenseElement represents a single license creation request.
6 properties 1 required
LicenseUnassignResponse
object
LicenseUnassignResponse represents the response after unassigning licenses.
4 properties
DeleteResult
object
DeleteResult represents the result of a single license deletion.
3 properties
LicenseUsageItem
object
LicenseUsageItem represents usage statistics for a single license type.
4 properties
ProductLicenseKey
string
ProductLicenseKey represents a commercial license key from a third-party vendor.
LicenseDeletionResponse
object
BatchDeleteResponse represents the response after batch deletion. This is named LicenseDeletionResponse in the OpenAPI spec.
4 properties
ErrorDetail
object
ErrorDetail represents error details in the delete response.
2 properties
LicenseUnassignResult
object
LicenseUnassignResult represents the result of a single license unassignment.
3 properties
LicensesAvailable
array
LicensesAvailable is an array of license usage statistics.
LicenseCreationResponse
object
LicenseCreationResponse represents the response after creating licenses.
2 properties
Error
object
Error represents the standard API error response.
4 properties
LicenseCreationRequest
array
LicenseCreationRequest is a list of license elements for creating licenses.
LicenseAssignResult
object
LicenseAssignResult represents the result of a single license assignment.
6 properties
LicenseOperations
array
LicenseOperations is an array of license operations.
LicenseType
string
LicenseTypeValue represents valid license type identifiers.
LicenseDetail
object
LicenseDetail represents a single license with all its details for the API response. This matches the OpenAPI spec where userid and extension can be null.
8 properties
LicenseCreationResponseItem
object
LicenseCreationResponseItem represents a single created license in the response.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nfon-licenses-api-openapi.yml Raw ↑

Other APIs Nfon publishes across the network.

NFON Service Portal API (legacy)
Nfon Accounts API
Nfon address API
Nfon authentication API
Nfon Blacklist Profiles API
Nfon clip-screened-prefixes API
Nfon Contract Types API
Nfon Customer Announcements API
Nfon Customer Conference API
Nfon Customer Contracts API
Nfon Customer Device Types API
Nfon Customer Devices API