BusinessAPISettings Object

Contains information about the settings to apply to all APIs within the business, unless specified otherwise at a lower level.

This object is used by the following operations:

The properties included in the BusinessAPISettings object are listed below. All values are optional.

Property Type Description
PublicAPISupport String Indicates whether public API support is enabled or disabled.
PublicAPISandboxEndpointSupport String Indicates whether public API sandbox endpoint support is enabled or disabled.
PublicAPIProductionEndpointSupport String Indicates whether public API production endpoint support is enabled or disabled.
PublicAPISandboxAutoApprovalSupport String Indicates whether automatic approval of requests for access to the Sandbox implementation for a public API is enabled or disabled.
PublicAPIProductionAutoApprovalSupport String Indicates whether automatic approval of requests for access to the Live implementation for a public API is enabled or disabled.
PublicAPIBoardSupport String Indicates whether public API Board support is enabled or disabled.
PublicAPIRatingsSupport String Indicates whether public API ratings support is enabled or disabled.
PublicAPIReviewsSupport String Indicates whether public API review support is enabled or disabled.
PrivateAPISupport String Indicates whether Private API support is enabled or disabled.
PrivateAPISandboxEndpointSupport String Indicates whether Private API sandbox endpoint support is enabled or disabled.
PrivateAPIProductionEndpointSupport String Indicates whether Private API sandbox production support is enabled or disabled.
PrivateAPISandboxAutoApprovalSupport String Indicates whether automatic approval of requests for access to the sandbox implementation for a Private API is enabled or disabled.
PrivateAPIProductionAutoApprovalSupport String Indicates whether automatic approval of requests for access to the Live implementation for a Private API is enabled or disabled.
PrivateAPIGroupTypeSupport String

Indicates whether API Scope Group (Private API Group) support is enabled or disabled.

Note: This setting is general to all APIs, not just private APIs.

PrivateAPIIndependentGroupSupport String Indicates whether independent group support is enabled or disabled.
PrivateAPIBoardSupport String Indicates whether Private API Board support is enabled or disabled.
PrivateAPIRatingsSupport String Indicates whether Private API ratings support is enabled or disabled.
PrivateAPIReviewsSupport String Indicates whether Private API review support is enabled or disabled.
PublicAPIResourceLevelPermissionsSupport String Indicates whether resource-level scope mapping support is enabled for public APIs.
PrivateAPIResourceLevelPermissionsSupport String Indicates whether resource-level scope mapping support is enabled for private APIs.
ApiVersionWorkflowDefKey String The unique workflow definition key for the custom workflow for APIs, if a custom workflow for APIs is in use.
ApiAdminMemberWorkflowDefKey String The unique workflow definition key for the custom workflow for API Admins, if a custom workflow for API Admins is in use.
APIWithNewServiceSupport String Indicates whether the Creation of API with New Service option is enabled or disabled.
APIWithExistingServiceSupport String Indicates whether the Creation of API with Existing Service option is enabled or disabled.
APIWithAnonymousAccessSupport String Indicates whether the API supports anonymous access.
APIPromotionSupport String Indicates whether API Admins can promote APIs between environments, in a scenario where the promotion feature is enabled in the implementation. If the promotion feature is implemented, and this option is enabled, the API Admin can promote the API to the next environment in the topology chain.
ValidateUniqueContextPath String Determines whether the developer portal validates that the context path is unique for each API. If disabled, the same context path is allowed for multiple APIs (for example, /acmepaymentscorp).

Back to top

Related Topics