Get platform preferences
/apiplatform/administration/v1/preferences/platform
Returns the platform preferences.
All authenticated users can access this resource. Users assigned a role other than admin only receive these fields and the HATEOAS links they have permission to access in the response: timeZoneID
, portalEnabled
, apiaryUrl
, and gatewayInstallerUrl
. Users assigned the admin role receive all fields and HATEOAS links for all related operations in the response.
Request
- application/json
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
- application/json
200 Response
object
-
links(optional):
array links
Includes 'canonical'.
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.
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.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
403 Response
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
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 retrieve the current Oracle API Platform Cloud Service platform preferences by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/administration/v1/preferences/platform
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 02 Jan 2017 13:40:09 GMT Content-length: 1253 Content-type: application/json X-oracle-dms-ecid: 07v^m0LqR00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the Oracle API Platform Cloud Service platform preferences and HATEOAS links:
{ "general": { "portalUrlType": "DEFAULT", "portalShowOAuthClientId": true, "apiaryUrl": "https://enterprise-integrations.apiary.io", "gatewayDownloadUrl": "./downloads/ApicsGatewayInstaller.zip", "timeZoneId": "PST8PDT", "portalCustomUrl": "", "portalShowAppKey": true, "portalEnabled": true, "allowUnauthenticatedUsers": false, "portalBaseUrl": "http://example.com:443/developers", "allowSelfRegistration": false }, "security": { "idcs": { "clientId": "", "endpointUrl": "", "description": "", "clientSecret": "" } }, "links": [ { "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform" }, { "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform" }, { "method": "PATCH", "rel": "edit", "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform" } ] }