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
- application/json
Root Schema : updateBasicAuthConfiguration_request
Type:
Show Source
object
-
headersWhitelist(optional):
array headersWhitelist
Header names that will exclude a request from the Basic Authentication functionality.
-
ipRangesWhitelist(optional):
array ipRangesWhitelist
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(optional):
array neverAuthenticateTargetHostNames
Target host names that will be excluded from basic authentication. These are typically the customer facing host names ("example.com").
-
nonBasicAuthBrowserTypes(optional):
array nonBasicAuthBrowserTypes
Browser types that are incompatible with the Basic Auth functionality, and should instead use the non-Basic Auth mechanism.
-
passwords(optional):
object passwords
Additional Properties Allowed: additionalPropertiesValid username/password combinations. The keys are the usernames and the values are the passwords.
-
pathWhitelist(optional):
array pathWhitelist
Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.
-
realm(optional):
string
The basic auth realm that will be presented as part of the basic auth challenge.
Example:
{
"neverAuthenticateTargetHostNames":[
"example.com",
"www.example.com"
],
"ipRangesWhitelist":[
"192.168.1.1 - 192.168.1.15"
],
"nonBasicAuthBrowserTypes":[
"MSIE",
"Safari",
"Edge",
"Trident"
],
"headersWhitelist":null,
"passwords":{
"admin":"admin"
},
"pathWhitelist":[
"/foo/bar"
],
"realm":"Oracle Cloud Commerce Testing"
}
Nested Schema : headersWhitelist
Type:
array
Header names that will exclude a request from the Basic Authentication functionality.
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 ("example.com").
Show Source
Nested Schema : nonBasicAuthBrowserTypes
Type:
array
Browser types that are incompatible with the Basic Auth functionality, and should instead use the non-Basic Auth mechanism.
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
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateBasicAuthConfiguration_response
Type:
Show Source
object
-
headersWhitelist(optional):
array headersWhitelist
Header names that will exclude a request from the Basic Authentication functionality.
-
ipRangesWhitelist(optional):
array ipRangesWhitelist
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(optional):
array neverAuthenticateTargetHostNames
Target host names that will be excluded from basic authentication. These are typically the customer facing host names ("example.com").
-
nonBasicAuthBrowserTypes(optional):
array nonBasicAuthBrowserTypes
Browser types that are incompatible with the Basic Auth functionality, and should instead use the non-Basic Auth mechanism.
-
passwords(optional):
object passwords
Additional Properties Allowed: additionalPropertiesValid username/password combinations.
-
pathWhitelist(optional):
array pathWhitelist
Site relative paths (for example, "/v1/ccadmin/login") that are excluded from basic authentication.
-
realm(optional):
string
The basic auth realm that will be presented as part of the basic auth challenge.
Nested Schema : headersWhitelist
Type:
array
Header names that will exclude a request from the Basic Authentication functionality.
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 ("example.com").
Show Source
Nested Schema : nonBasicAuthBrowserTypes
Type:
array
Browser types that are incompatible with the Basic Auth functionality, and should instead use the non-Basic Auth mechanism.
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":[
"example.com",
"www.example.com"
],
"ipRangesWhitelist":[
"192.168.1.1 - 192.168.1.15"
],
"nonBasicAuthBrowserTypes":[
"MSIE",
"Safari",
"Edge",
"Trident"
],
"headersWhitelist":null,
"passwords":{
"admin":"admin"
},
"pathWhitelist":[
"/foo/bar"
],
"realm":"Oracle Cloud Commerce Testing"
}
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.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code