ApiPortalPropertiesResponse

data class ApiPortalPropertiesResponse(val apiTryOutEnabledState: String? = null, val gatewayIds: List<String>? = null, val httpsOnly: Boolean? = null, val instances: List<ApiPortalInstanceResponse>, val provisioningState: String, val public: Boolean? = null, val resourceRequests: ApiPortalResourceRequestsResponse, val sourceUrls: List<String>? = null, val ssoProperties: SsoPropertiesResponse? = null, val url: String)

API portal properties payload

Constructors

Link copied to clipboard
constructor(apiTryOutEnabledState: String? = null, gatewayIds: List<String>? = null, httpsOnly: Boolean? = null, instances: List<ApiPortalInstanceResponse>, provisioningState: String, public: Boolean? = null, resourceRequests: ApiPortalResourceRequestsResponse, sourceUrls: List<String>? = null, ssoProperties: SsoPropertiesResponse? = null, url: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.

Link copied to clipboard
val gatewayIds: List<String>? = null

The array of resource Ids of gateway to integrate with API portal.

Link copied to clipboard
val httpsOnly: Boolean? = null

Indicate if only https is allowed.

Link copied to clipboard

Collection of instances belong to API portal.

Link copied to clipboard

State of the API portal.

Link copied to clipboard
val public: Boolean? = null

Indicates whether the API portal exposes endpoint.

Link copied to clipboard

The requested resource quantity for required CPU and Memory.

Link copied to clipboard
val sourceUrls: List<String>? = null

Collection of OpenAPI source URL locations.

Link copied to clipboard

Single sign-on related configuration

Link copied to clipboard
val url: String

URL of the API portal, exposed when 'public' is true.