tenduke::se::licensing::rest::ScaleConsumersApi Class Reference

#include <ScaleConsumersApi.h>

Detailed Description

Low-level license-consumers interface.

This matches the REST-API and implementations are used to access the REST API.

This is a factory for actual API requests: Methods return instances of "request"-classes. Executing the request makes the actual REST API call and returns the response.

Inheritance diagram for tenduke::se::licensing::rest::ScaleConsumersApi:

Public Member Functions
virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerClientBindingsRequest >	describeLicenseConsumerClientBindings (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging, const ::tenduke::se::Filter &filter) const =0
	Analyzes licenses that a license consumer is known to have a checkout for currently.
virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerLicenseesRequest >	describeLicenseConsumerLicensees (const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging) const =0
	Analyzes what licensees a license consumer is associated to.
virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerLicensesRequest >	describeLicenseConsumerLicenses (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging) const =0
	Analyzes licenses that a license consumer has access to and describes the license status to determine the likely outcome if trying to use the licenses.

Member Function Documentation

describeLicenseConsumerClientBindings()

virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerClientBindingsRequest > tenduke::se::licensing::rest::ScaleConsumersApi::describeLicenseConsumerClientBindings ( const std::string &  licenseeId, const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging, const ::tenduke::se::Filter &  filter  ) const

pure virtual

Analyzes licenses that a license consumer is known to have a checkout for currently.

This endpoint can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.

Parameters

licenseeId	Identifier of the licensee that the license belongs to.
licenseConsumerId	Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model.
paging	-
filter	-

Implemented in tenduke::se::licensing::rest::ScaleConsumersApiImpl.

describeLicenseConsumerLicensees()

virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerLicenseesRequest > tenduke::se::licensing::rest::ScaleConsumersApi::describeLicenseConsumerLicensees ( const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging  ) const

pure virtual

Analyzes what licensees a license consumer is associated to.

The association is defined as a relation between a license consumer and one or more license containers that belong to licensees. This endpoint can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.

Parameters

licenseConsumerId	Identifier of the license consumer whos licensee associations are responded. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model.
paging	-

Returns

-

Implemented in tenduke::se::licensing::rest::ScaleConsumersApiImpl.

describeLicenseConsumerLicenses()

virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseConsumerLicensesRequest > tenduke::se::licensing::rest::ScaleConsumersApi::describeLicenseConsumerLicenses ( const std::string &  licenseeId, const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging  ) const

pure virtual

Analyzes licenses that a license consumer has access to and describes the license status to determine the likely outcome if trying to use the licenses.

This endpoint can be called using either Scale JWT authorization or an OIDC ID Token. When using Scale JWT authorization, the minimum permission grant definition is Licensing.action. NOTE: Paging parameters apply to licenses (the main level of data in the response). In other words, paging does not affect the additional information that is included in the response when parameter withMetadata == true.

Parameters

licenseeId	Identifier of the licensee that the license belongs to.
licenseConsumerId	Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model.
paging	-

Returns

-

Implemented in tenduke::se::licensing::rest::ScaleConsumersApiImpl.

---

The documentation for this class was generated from the following file:

• api/src/licensing/rest/consumers/ScaleConsumersApi.h