updateBasicAuthConfiguration

put

/ccadmin/v1/merchant/basicAuth

Update Basic Auth Configuration. Updates 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

Supported Media Types
Body ()
Root Schema : updateBasicAuthConfiguration_request
Type: object
Show Source
Example:
{
    "neverAuthenticateTargetHostNames":[
        "mystore.com",
        "www.mystore.com"
    ],
    "ipRangesWhitelist":[
        "192.168.1.1 - 192.168.1.15"
    ],
    "passwords":{
        "admin":"admin"
    },
    "pathWhitelist":[
        "/foo/bar"
    ],
    "realm":"Oracle Cloud Commerce Testing",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/merchant/basicAuth"
        }
    ],
    "enabled":true
}
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.
Show Source
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").
Show Source
Nested Schema : passwords
Type: object
Additional Properties Allowed
Show Source
Valid username/password combinations. The keys are the usernames and the values are the passwords.
Nested Schema : pathWhitelist
Type: array
Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateBasicAuthConfiguration_response
Type: object
Show Source
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.
Show Source
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").
Show Source
Nested Schema : passwords
Type: object
Additional Properties Allowed
Show Source
Valid username/password combinations.
Nested Schema : pathWhitelist
Type: array
Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.
Show Source
Example Response (application/json)
{
    "neverAuthenticateTargetHostNames":[
        "mystore.com",
        "www.mystore.com"
    ],
    "ipRangesWhitelist":[
        "192.168.1.1 - 192.168.1.15"
    ],
    "passwords":{
        "admin":"admin"
    },
    "pathWhitelist":[
        "/foo/bar"
    ],
    "realm":"Oracle Cloud Commerce Testing",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/merchant/basicAuth"
        }
    ],
    "enabled":true
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |13001|Validation errors were found in the input.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top