Update platform preferences
patch
/apiplatform/administration/v1/preferences/platform
Updates the platform preferences. Request must be in the merge patch format specified in RFC 7396.
Request
Supported Media Types
- application/merge-patch+json
Nested Schema : GeneralPlatformPreferences
Type:
Show Source
object
-
allowSelfRegistration(optional):
boolean
Default Value:
false
Allow self registration. -
allowUnauthenticatedUsers(optional):
boolean
Default Value:
false
Allow unauthenticated users. -
apiaryUrl(optional):
string
The Apiary integration URL.
-
gatewayDownloadUrl(optional):
string
The gateway installer download URL.
-
portalBaseUrl(optional):
string
The default Developer Portal URL.
-
portalCustomUrl(optional):
string
The custom Developer Portal URL. This string is used only if
portalUrlType
is set toCUSTOM
. -
portalEnabled(optional):
boolean
Default Value:
true
Indicates if the Developer Portal is enabled. Value istrue
if enabled andfalse
if disabled. -
portalShowAppKey(optional):
boolean
Default Value:
true
Indicates if application keys are displayed in the Developer Portal. Value istrue
if application keys are displayed andfalse
if they are hidden. -
portalShowOAuthClientId(optional):
boolean
Default Value:
true
Indicates if OAuth Client IDs and Client Secrets are displayed in the Developer Portal. Value istrue
if Client IDs and Client Secrets are displayed andfalse
if they are hidden. -
portalUrlType(optional):
string
Default Value:
DEFAULT
Allowed Values:[ "DEFAULT", "CUSTOM" ]
Indicates if the default Developer Portal URL is being used or if a custom URL is configured. Value is DEFAULT if using the default Developer Portal URL and CUSTOM if a custom Developer Portal URL is configured. -
timeZoneId(optional):
string
Platform time zone ID setting.
Nested Schema : IdcsSecurity
Type:
Show Source
object
-
clientId(optional):
string
The client ID.
-
clientSecret(optional):
string
The client secret.
-
description(optional):
string
A short description.
-
url(optional):
string
The IDCS endpoint URL.
Response
Supported Media Types
- application/json
204 Response
Platform preferences successfully updated.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update the Oracle API Platform Cloud Service Platform settings by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X PATCH -u apicsadmin:password -H "Content-Type:application/merge-patch+json" -d @preferences.json https://example.com/apiplatform/administration/v1/preferences/platform
Example of Request Body
The following sample request body in JSON format (included with the request above in a file named preferences.json
) updates the platform settings to disable the Developer Portal. All fields are optional; send only the field(s) you want to update in the request.
{ "general": { "portalEnabled": true } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 09 Feb 2018 10:06:58 GMT Content-type: application/json X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000c086 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0