BusinessAppSettings Object
Default settings to apply to all apps within the business, unless specified otherwise at a lower level.
This object is used by the following operations:
- PUT /api/businesses/{BusinessID}/appsettings
- GET /api/businesses/{BusinessID}/appsettings
- Operations that reference the Resource object
- Operations that reference the BusinessSettings object
- Operations that reference the Business object
The properties included in the BusinessAppSettings object are listed below.
| Property | Type | Description |
|---|---|---|
| PublicAppSupport | string | Indicates whether public app support is enabled or disabled. For values, see App Settings. |
| PublicAppBoardSupport | string | Indicates whether public app Board support is enabled or disabled. For values, see App Settings. |
| PublicAppRatingsSupport | string | Indicates whether public app ratings support is enabled or disabled. For values, see App Settings. |
| PublicAppReviewsSupport | string | Indicates whether public app review support is enabled or disabled. For values, see App Settings. |
| PrivateAppSupport | string | Indicates whether Private app support is enabled or disabled. For values, see App Settings. |
| PrivateAppBoardSupport | string | Indicates whether Private app Board support is enabled or disabled. For values, see App Settings. |
| PrivateAppRatingsSupport | string | Indicates whether Private app ratings support is enabled or disabled. For values, see App Settings. |
| PrivateAppReviewsSupport | string | Indicates whether Private app review support is enabled or disabled. For values, see App Settings. |
| UserDefinedIdentitySupport | string | Indicates whether user-defined identity support is enabled or disabled. For values, see App Settings. |
| SimultaneousSandboxProductAccessSupport | string | Indicates whether simultaneous access to Sandbox and Live implementations is supported or not. For values, see App Settings. |
| AppVersionWorkflowDefKey | string | The unique workflow definition key for the custom workflow for apps, if a custom workflow for apps is in use. |
| AppTeamMemberWorkflowDefKey | string | The unique workflow definition key for the custom workflow for app team members, if a custom workflow for app team members is in use. |
| ReturnPlainTextSharedSecret | string | Indicates whether the Shared Secret, if requested, should be returned in plain text. For values, see App Settings. |
| RegisteredUsersAppSupport | string | Determines whether apps with a visibility setting of Registered Users will be supported on the platform. Apps with this setting are visible only to users who are logged in. |
| RegisteredUsersAppRatingsSupport | string | Determines whether users will be able to rate apps with a visibility setting of Registered Users. If this setting is disabled, the ratings feature does not appear in the user interface for apps with this visibility setting. |
| RegisteredUsersAppReviewsSupport | string | Determines whether users will be able to write and share reviews of apps with a visibility setting of Registered Users. If this setting is disabled, the reviews feature does not appear in the user interface for apps with this visibility setting. |
| AppPromotionSupport | string | Indicates whether app developers can promote apps 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 app developer can promote the app to the next environment in the topology chain. |
|
ContractPoliciesSupport Valid in version: 2020.1.0 and later |
string |
Determines whether policies attached to the API are shown as part of the API Access wizard when an app requests a contract with an API. Default: com.soa.feature.enabled: policies are visible to app developers. Include this setting, with a value of com.soa.feature.disabled, if you do not want the app developer to see the policies attached to the API, when requesting API access. |