REST API for Oracle Commerce Cloud December 2017

getBasicAuthConfiguration

get

/ccadmin/v1/merchant/basicAuth

Get Basic Auth Configuration. Gets basic authentication configuration. The basic auth system is meant to prevent acciddental access to servers, and is not intended to be a highly secure.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getBasicAuthConfiguration_response

Properties

enabled: Type: boolean

Whether the basic auth system is enabled. Oracle strongly advises against disabling basic auth as this exposes non-production systems to web crawlers which could return non-production URLs in public search results.
ipRangesWhitelist: Type: array ipRangesWhitelist

Additional Properties Allowed:

Represents client IP addresses or ranges of client IP addresses that are whitelisted and therefore do not have to provide basic auth authentication. IPv4 and IPv6 addresses are supported. Ranges are specified via a pair of IP addresses using '-' as a separator, or specified via CIDR notation. DNS/host names are not supported.
neverAuthenticateTargetHostNames: Type: array neverAuthenticateTargetHostNames

Additional Properties Allowed:

Target host names that will be excluded from basic authentication. These are typically the customer facing host names ("mystore.com").
passwords: Type: object passwords

Additional Properties Allowed: { "type":"string" }

Valid username/password combinations.
pathWhitelist: Type: array pathWhitelist

Additional Properties Allowed:

Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.
realm: Type: string

The basic auth realm that will be presented as part of the basic auth challenge.

Nested Schema : ipRangesWhitelist

Type: array

Represents client IP addresses or ranges of client IP addresses that are whitelisted and therefore do not have to provide basic auth authentication. IPv4 and IPv6 addresses are supported. Ranges are specified via a pair of IP addresses using '-' as a separator, or specified via CIDR notation. DNS/host names are not supported.

Items

Type: string

Nested Schema : neverAuthenticateTargetHostNames

Type: array

Target host names that will be excluded from basic authentication. These are typically the customer facing host names ("mystore.com").

Items

Type: string

Nested Schema : passwords

Type: object

Additional Properties Allowed

Type: string

Valid username/password combinations.

Nested Schema : pathWhitelist

Type: array

Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.

Items

Type: string

Example application/json


{
    "neverAuthenticateTargetHostNames":[
        "mystore.com",
        "www.mystore.com"
    ],
    "ipRangesWhitelist":[
        "192.168.1.1 - 192.168.1.15"
    ],
    "passwords":{
        "admin":"admin"
    },
    "pathWhitelist":null,
    "realm":"Oracle Cloud Commerce Testing",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/merchant/basicAuth"
        }
    ],
    "enabled":true
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "neverAuthenticateTargetHostNames": [
    "mystore.com",
    "www.mystore.com"
  ],
  "ipRangesWhitelist": ["192.168.1.1 - 192.168.1.15"],
  "passwords": {"admin": "admin"},
  "pathWhitelist": null,
  "realm": "Oracle Cloud Commerce Testing",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/merchant/basicAuth"
  }],
  "enabled": true
}