Skip to content
OclavexOclavex Docs

Overview

Oclavex Provision API v1

Section titled “Oclavex Provision API v1”

API for Entitlement Management, Licensing and Usage Monitoring

API version v1. The v1 contract is stable: changes are additive (new optional fields and endpoints); breaking changes are introduced under a new major version (/api/v2), never in place.

Operations

Section titled “Operations”
GET
/api/v1/provision/service
PUT
/api/v1/provision/operational/asset-balances/{balanceId}/value
PUT
/api/v1/provision/operational/asset-balances/{balanceId}/withdraw
PUT
/api/v1/provision/operational/asset-balances/{balanceId}/suspend-until
PUT
/api/v1/provision/operational/asset-balances/{balanceId}/resume
GET
/api/v1/provision/operational/entitlements/{entitlementId}/activation-codes
POST
/api/v1/provision/operational/entitlements/{entitlementId}/activation-codes
DELETE
/api/v1/provision/operational/entitlements/{entitlementId}/activation-codes/{activationCodeId}
POST
/api/v1/provision/operational/entitlements/{entitlementId}/enable-activations
POST
/api/v1/provision/operational/entitlements/{entitlementId}/disable-activations
POST
/api/v1/provision/operational/entitlements/{entitlementId}/revoke
POST
/api/v1/provision/operational/entitlements/{entitlementId}/reinstate
PUT
/api/v1/provision/operational/entitlements/{entitlementId}/policies/license-allocation/seats
PUT
/api/v1/provision/operational/entitlements/{entitlementId}/policies/subscription/renew-periods
PUT
/api/v1/provision/operational/entitlements/{entitlementId}/policies/subscription/active
PUT
/api/v1/provision/operational/entitlements/{entitlementId}/policies/trial/restart-trial
GET
/api/v1/provision/operational/entitlements/{entitlementId}/activations/remaining
GET
/api/v1/provision/operational/entitlements/{entitlementId}/activations
POST
/api/v1/provision/operational/activations/offline/issue
POST
/api/v1/provision/operational/usage/offline/ingest
POST
/api/v1/provision/usage/sessions/{sessionId}/transactions
POST
/api/v1/provision/usage/entitlements/{entitlementId}/transactions
POST
/api/v1/provision/usage/try-preallocate/{sessionId}/{metric}
POST
/api/v1/provision/usage/try-consume/{sessionId}/{metric}
GET
/api/v1/provision/usage/{sessionId}/{metric}/usage
GET
/api/v1/provision/usage/{sessionId}/{metric}/consumption
GET
/api/v1/provision/usage/sessions/{sessionId}/rating-prompt
POST
/api/v1/provision/activations/admission/check
POST
/api/v1/provision/consumer/me/rating
GET
/api/v1/provision/consumer/me/feedback
POST
/api/v1/provision/consumer/me/feedback
GET
/api/v1/provision/consumer/me/plan-change-requests
POST
/api/v1/provision/consumer/me/plan-change-requests
POST
/api/v1/provision/consumer/me/credits/grant
GET
/api/v1/provision/consumer/me/credits/{metric}/spending
POST
/api/v1/provision/consumer/me/credits/{metric}/spending
GET
/api/v1/provision/consumer/me/sessions/{sessionId}/plan
GET
/api/v1/provision/consumer/me/sessions/{sessionId}/plans
GET
/api/v1/provision/consumer/me/sessions
GET
/api/v1/provision/consumer/me/rating-prompt
GET
/api/v1/provision/consumer/me/activation-codes
GET
/api/v1/provision/consumer/me/confirm-activation-identity/{code}
GET
/api/v1/provision/consumer/me/entitlements/{entitlementId}/plan
GET
/api/v1/provision/consumer/me/entitlements/{entitlementId}/plans
GET
/api/v1/provision/consumer/me/entitlements/{entitlementId}/monitored-assets
POST
/api/v1/provision/activations/jwt
POST
/api/v1/provision/activations/license
POST
/api/v1/provision/activations/{sessionId}/renew
POST
/api/v1/provision/activations/{sessionId}/check-in
POST
/api/v1/provision/activations/{sessionId}/release
GET
/api/v1/provision/consumer/me/entitlements
GET
/api/v1/provision/admin/usage-plans/add-ons
POST
/api/v1/provision/admin/usage-plans/add-ons
GET
/api/v1/provision/admin/usage-plans/add-ons/by-suite/{suiteId}
GET
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}
PUT
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}
DELETE
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}
POST
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/features/{featureCatalogId}
DELETE
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/features/{featureCatalogId}
POST
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/publish
POST
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/archive
POST
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/draft
POST
/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/clone-draft
GET
/api/v1/provision/admin/suites
POST
/api/v1/provision/admin/suites
GET
/api/v1/provision/admin/suites/by-product/{productId}
GET
/api/v1/provision/admin/suites/{suiteId}
PUT
/api/v1/provision/admin/suites/{suiteId}
DELETE
/api/v1/provision/admin/suites/{suiteId}
POST
/api/v1/provision/admin/suites/{suiteId}/members/{productId}
DELETE
/api/v1/provision/admin/suites/{suiteId}/members/{productId}
PUT
/api/v1/provision/admin/suites/{suiteId}/members/reorder
GET
/api/v1/provision/admin/usage-plans/plan-sets
POST
/api/v1/provision/admin/usage-plans/plan-sets
GET
/api/v1/provision/admin/usage-plans/plan-sets/by-product/{productId}
GET
/api/v1/provision/admin/usage-plans/plan-sets/by-suite/{suiteId}
GET
/api/v1/provision/admin/usage-plans/plan-sets/{planSetId}
PUT
/api/v1/provision/admin/usage-plans/plan-sets/{planSetId}
DELETE
/api/v1/provision/admin/usage-plans/plan-sets/{planSetId}
POST
/api/v1/provision/admin/usage-plans/plan-sets/{planSetId}/plans
DELETE
/api/v1/provision/admin/usage-plans/plan-sets/{planSetId}/plans/{planId}
GET
/api/v1/provision/admin/sessions/activations
GET
/api/v1/provision/admin/sessions/activations/by-user/{userId}
GET
/api/v1/provision/admin/sessions/activations/by-organization/{organizationId}
GET
/api/v1/provision/admin/reports/usage-metrics
GET
/api/v1/provision/admin/reports/usage-metrics/breakdown
GET
/api/v1/provision/admin/reports/usage-analytics
GET
/api/v1/provision/admin/reports/feature-value
GET
/api/v1/provision/admin/reports/campaign-performance
GET
/api/v1/provision/admin/providers
GET
/api/v1/provision/admin/providers/license-signing-key
GET
/api/v1/provision/admin/providers/license-signing-keys
POST
/api/v1/provision/admin/providers/license-signing-keys
POST
/api/v1/provision/admin/providers/license-signing-keys/{keyId}/promote
DELETE
/api/v1/provision/admin/providers/license-signing-keys/{keyId}
GET
/api/v1/provision/admin/products/{productId}/monitored-assets
POST
/api/v1/provision/admin/products/{productId}/monitored-assets
PUT
/api/v1/provision/admin/products/{productId}/monitored-assets/{monitoredAssetId}
DELETE
/api/v1/provision/admin/products/{productId}/monitored-assets/{monitoredAssetId}
GET
/api/v1/provision/admin/rating-campaigns
POST
/api/v1/provision/admin/rating-campaigns
GET
/api/v1/provision/admin/rating-campaigns/{id}
PUT
/api/v1/provision/admin/rating-campaigns/{id}
DELETE
/api/v1/provision/admin/rating-campaigns/{id}
GET
/api/v1/provision/admin/products
POST
/api/v1/provision/admin/products
GET
/api/v1/provision/admin/products/{productId}
DELETE
/api/v1/provision/admin/products/{productId}
PATCH
/api/v1/provision/admin/products/{productId}
POST
/api/v1/provision/admin/products/{productId}/duplicate-as-new-version
PUT
/api/v1/provision/admin/products/{productId}/status
POST
/api/v1/provision/admin/products/import
GET
/api/v1/provision/admin/products/{productId}/metrics
POST
/api/v1/provision/admin/products/{productId}/metrics
DELETE
/api/v1/provision/admin/products/{productId}/metrics/{metricId}
PATCH
/api/v1/provision/admin/products/{productId}/metrics/{metricId}
GET
/api/v1/provision/admin/feature-catalog
POST
/api/v1/provision/admin/feature-catalog
GET
/api/v1/provision/admin/feature-catalog/usage
GET
/api/v1/provision/admin/feature-catalog/{id}
PUT
/api/v1/provision/admin/feature-catalog/{id}
PUT
/api/v1/provision/admin/feature-catalog/{id}/lifecycle
GET
/api/v1/provision/admin/products/{productId}/features
POST
/api/v1/provision/admin/products/{productId}/features
DELETE
/api/v1/provision/admin/products/{productId}/features/{featureId}
PATCH
/api/v1/provision/admin/products/{productId}/features/{featureId}
GET
/api/v1/provision/admin/platform-quota/usage
GET
/api/v1/provision/admin/plan-change-requests
POST
/api/v1/provision/admin/plan-change-requests/{requestId}/approve
POST
/api/v1/provision/admin/plan-change-requests/{requestId}/reject
GET
/api/v1/provision/admin/feedback
POST
/api/v1/provision/admin/feedback/{feedbackId}/accept
POST
/api/v1/provision/admin/feedback/{feedbackId}/decline
POST
/api/v1/provision/admin/feedback/{feedbackId}/duplicate
POST
/api/v1/provision/admin/entitlements/{entitlementId}/activation-workflow/batch/generate
POST
/api/v1/provision/admin/entitlements/{entitlementId}/activation-workflow/batch/import
GET
/api/v1/provision/admin/entitlements/{entitlementId}/activation-workflow
POST
/api/v1/provision/admin/entitlements/{entitlementId}/activation-workflow
PUT
/api/v1/provision/admin/entitlements/activation-workflow/{activationWorkflowId}
DELETE
/api/v1/provision/admin/entitlements/activation-workflow/{activationCodeId}
GET
/api/v1/provision/admin/entitlements
POST
/api/v1/provision/admin/entitlements
GET
/api/v1/provision/admin/entitlements/{entitlementId}
PATCH
/api/v1/provision/admin/entitlements/{entitlementId}
GET
/api/v1/provision/admin/entitlements/by-license-key/{licenseKey}
GET
/api/v1/provision/admin/entitlements/by-external-reference/{externalReference}
GET
/api/v1/provision/admin/entitlements/anonymous-try/funnel
GET
/api/v1/provision/admin/entitlements/by-session/{sessionId}
POST
/api/v1/provision/admin/entitlements/{entitlementId}/enable-activations
POST
/api/v1/provision/admin/entitlements/{entitlementId}/disable-activations
POST
/api/v1/provision/admin/entitlements/{entitlementId}/pause
POST
/api/v1/provision/admin/entitlements/{entitlementId}/resume
POST
/api/v1/provision/admin/entitlements/{entitlementId}/apply-plan
POST
/api/v1/provision/admin/entitlements/{entitlementId}/apply-plan-name
POST
/api/v1/provision/admin/entitlements/{entitlementId}/temporary-override
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/temporary-override
GET
/api/v1/provision/admin/entitlements/{entitlementId}/add-on-grants
POST
/api/v1/provision/admin/entitlements/{entitlementId}/add-on-grants
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/add-on-grants/{addOnGrantId}
GET
/api/v1/provision/admin/entitlements/{entitlementId}/usage-overview
GET
/api/v1/provision/admin/entitlements/{entitlementId}/campaign-attributions
POST
/api/v1/provision/admin/entitlements/{entitlementId}/campaign-attributions
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/campaign-attributions/{attributionId}
POST
/api/v1/provision/admin/entitlements/offers
POST
/api/v1/provision/admin/entitlements/offers/to-offer
POST
/api/v1/provision/admin/entitlements/offers/from-offer
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/license-allocation
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/license-allocation
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/key-issuance
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/key-issuance
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/trial
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/trial
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/time-restricted
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/time-restricted
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/subscription
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/subscription
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/activation
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/anonymous-try
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/policies/anonymous-try
POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/plan-change
POST
/api/v1/provision/admin/entitlements/{entitlementId}/principals/{principalId}
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/principals/{principalId}
GET
/api/v1/provision/admin/entitlements/{entitlementId}/principals
POST
/api/v1/provision/admin/entitlements/{entitlementId}/products/{productId}
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/products/{productId}
PUT
/api/v1/provision/admin/entitlements/{entitlementId}/governing-suite/{suiteId}
POST
/api/v1/provision/admin/entitlements/{entitlementId}/suites/{suiteId}
PUT
/api/v1/provision/admin/entitlements/{entitlementId}/suites/{suiteId}/sync
DELETE
/api/v1/provision/admin/entitlements/{entitlementId}/suite
GET
/api/v1/provision/admin/entitlements/{entitlementId}/features
PUT
/api/v1/provision/admin/entitlements/{entitlementId}/features/{featureId}
GET
/api/v1/provision/admin/catalog/export
POST
/api/v1/provision/admin/catalog/export
POST
/api/v1/provision/admin/catalog/import
POST
/api/v1/provision/admin/catalog/compare
POST
/api/v1/provision/admin/catalog/import/selection
GET
/api/v1/provision/admin/tags
POST
/api/v1/provision/admin/tags
GET
/api/v1/provision/admin/tags/{tagId}
DELETE
/api/v1/provision/admin/tags/{tagId}
PATCH
/api/v1/provision/admin/tags/{tagId}
POST
/api/v1/provision/admin/tags/{tagId}/merge
GET
/api/v1/provision/admin/campaigns
POST
/api/v1/provision/admin/campaigns
GET
/api/v1/provision/admin/campaigns/{id}
PUT
/api/v1/provision/admin/campaigns/{id}
DELETE
/api/v1/provision/admin/campaigns/{id}
GET
/api/v1/provision/admin/monitored-assets/{assetId}
PUT
/api/v1/provision/admin/monitored-assets/{assetId}
GET
/api/v1/provision/admin/monitored-assets
GET
/api/v1/provision/admin/monitored-assets/by-entitlement/{entitlementId}
GET
/api/v1/provision/admin/monitored-assets/by-session/{sessionId}
GET
/api/v1/provision/admin/asset-balances/{balanceId}
DELETE
/api/v1/provision/admin/asset-balances/{balanceId}
PATCH
/api/v1/provision/admin/asset-balances/{balanceId}
GET
/api/v1/provision/admin/monitored-assets/{monitoredAssetId}/usage

Authentication

Section titled “Authentication”

oidc

Section titled “oidc”

OpenID Connect authentication using Authorization Code Flow. api.example.com stands in for your tenant endpoint — replace it with your own host.

Security scheme type: openIdConnect

OpenID Connect URL: https://api.example.com/auth/.well-known/openid-configuration