Get Portal Catalog Cover

Returns the portal catalog cover or returns the default

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

Catalog Cover of the portal. Can be either png or jpg

GetPortalAppearanceLogoResponse

GetPortalAppearanceLogoResponsestring
get/portals/{portalId}/appearance/catalog-cover
 

Portal Product Versions

Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal.

They contain:

  • Lifecyle and deprecation statuses
  • Application registration settings like auto approve or whether application registration is enabled
  • The authentication strategy that is enabled for Application Registration

List portal product versions

List portal product versions

get

Query Parameters

sortstring

Sorts a collection of Portal Product Versions. Supported sort attributes are:

  • created_at
  • updated_at
  • publish_status
  • product_version_id
  • auth_strategy_ids
  • application_registration_enabled
  • auto_approve_registration
  • deprecated
filterobject

Filters a collection of Portal Product Versions.

* Additional properties are NOT allowed.
Show Child Parameters
page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A response containing a list of portal product versions

ListPortalProductVersions

A paginated list response for a collection of portal product versions

* Additional properties are NOT allowed.
dataarray[object]required

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.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals/{portalId}/product-versions
 
application/json

Create a portal product version

Create a portal product version

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

CreatePortalProductVersionPayload

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

Response

application/json

A response containing a portal product version

PortalProductVersion

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

post/portals/{portalId}/product-versions

Body

{ "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289", "auth_strategy_ids": [ "44f8380e-7798-4566-99e3-2edf2b57d289" ], "publish_status": "published", "application_registration_enabled": true, "auto_approve_registration": true, "deprecated": false }
 
application/json

Get a portal product version

Get a portal product version

get

Path Parameters

productVersionIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A response containing a portal product version

PortalProductVersion

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

get/portals/{portalId}/product-versions/{productVersionId}
 
application/json