PortalAssignedRoleResponse

object

An assigned role associates a service and an action to a team.

idstring(uuid)required

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

ListPortalsResponse

object

A paginated list of portals in the current region in the organization.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"9f9fd312-a987-4628-b4c5-bb4f4fddd5f7","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","name":"Portal A","display_name":"Developer Portal A","description":"The Portal A","default_domain":"123455678abcd.us.portal.konghq.com","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}

* Additional properties are NOT allowed.
Show Child Parameters
Example

ListPortalProductsResponse

object

A paginated list of API products published to a portal.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"7cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4}

* Additional properties are NOT allowed.
Show Child Parameters
Example

PortalProductFilters

object
* Additional properties are NOT allowed.
idOne Of

Filters on the given UUID field value by exact match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
nameOne Of

Filters on the given string field value by either exact or fuzzy match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
descriptionOne Of

Filters on the given string field value by either exact or fuzzy match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
Example

PortalProductVersionFilters

object
* Additional properties are NOT allowed.
idOne Of

Filters on the given UUID field value by exact match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
publish_statusOne Of

Filters on the given publish status

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
product_version_idOne Of

Filters on the given UUID field value by exact match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

auth_strategy_idsOne Of

Filters on the given UUID field value by exact match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
application_registration_enabledboolean

Filter by a boolean value (true/false).

auto_approve_registrationboolean

Filter by a boolean value (true/false).

deprecatedboolean

Filter by a boolean value (true/false).

Example