List portal product versions
List portal product versions
Query Parameters
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
Filters a collection of Portal Product Versions.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
ID of the portal.
Response
application/json
Response
A response containing a list of portal product versions
ListPortalProductVersions
A paginated list response for a collection of portal product versions
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
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a portal product version
Create a portal product version
Path Parameters
ID of the portal.
Body
application/json
Body
CreatePortalProductVersionPayload
Payload to create a Portal Product Version
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
>= 0 items<= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Response
application/json
Response
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
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
One OfA list of authentication strategies
>= 0 items<= 1 items
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Authentication
Path Parameters
Body
Get a portal product version
Get a portal product version
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal.
Response
application/json
Response
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
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
One OfA list of authentication strategies
>= 0 items<= 1 items
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Authentication
Path Parameters
Update a portal product version
Update a portal product version
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal.
Body
application/json
Body
UpdatePortalProductVersionPayload
Payload to update a Portal Product Version
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
>= 0 items<= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Whether to notify developers who are affected by this change
Response
application/json
Response
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
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
One OfA list of authentication strategies
>= 0 items<= 1 items
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Authentication
Path Parameters
Body
Replace a portal product version
Replace a portal product version
Path Parameters
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the portal.
Body
application/json
Body
ReplacePortalProductVersionPayload
Payload to update a Portal Product Version
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
>= 0 items<= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated
Whether to notify developers who are affected by this change
Response
application/json
Response
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
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Publication status of the API product version on the portal
Allowed values:publishedunpublished
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
One OfA list of authentication strategies
>= 0 items<= 1 items
KeyAuth Auth strategy that the application uses.
Show Child Parameters
Whether the application registration on this portal for the api product version is enabled
Whether the application registration auto approval on this portal for the api product version is enabled
Whether the api product version on the portal is deprecated