PublishAPIProductPayload,

object

Payload to publish/unpublish multiple API products

* Additional properties are NOT allowed.
api_productsobjectrequired
Example

CreatePortalProductVersionPayload

object

Payload to create a Portal Product Version

* Additional properties are NOT allowed.
publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

product_version_idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

auth_strategy_idsarray[string](uuid)required

Contains a unique identifier used for this resource.

>= 0 items<= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

Example

ReplacePortalProductVersionPayload

object

Payload to update a Portal Product Version

* Additional properties are NOT allowed.
publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

auth_strategy_idsarray[string](uuid)required

Contains a unique identifier used for this resource.

>= 0 items<= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

notify_developersboolean

Whether to notify developers who are affected by this change

Example

UpdatePortalProductVersionPayload

object

Payload to update a Portal Product Version

* Additional properties are NOT allowed.
publish_statusstring

Publication status of the API product version on the portal

Allowed values:publishedunpublished

auth_strategy_idsarray[string](uuid)

Contains a unique identifier used for this resource.

>= 0 items<= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

application_registration_enabledboolean

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationboolean

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedboolean

Whether the api product version on the portal is deprecated

notify_developersboolean

Whether to notify developers who are affected by this change

Example

PortalProductVersion

object

A Portal Product Version holds metadata that describes how a Product Version is configured for a specific portal.

It contains:

  • Lifecyle and deprecation statuses
  • Application registration settings like auto approve or whether application registration is enabled
  • The Authentication Strategy (if present) that is enabled for Application Registration
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

publish_statusstringrequired

Publication status of the API product version on the portal

Allowed values:publishedunpublished

product_version_idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

auth_strategiesOne Of
array[object]required

A list of authentication strategies

>= 0 items<= 1 items

AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
application_registration_enabledbooleanrequired

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationbooleanrequired

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedbooleanrequired

Whether the api product version on the portal is deprecated

Example