REST API for Oracle Commerce Cloud December 2017

updateRestrictedWords

post

/ccadmin/v1/merchant/profilePolicies/updateRestrictedWords

Updates customer's specific restricted words not to be used as a password.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : updateRestrictedWords_request

Example


{
    "add":[
        "Admin123",
        "Password123"
    ],
    "delete":[
        "Password",
        "QWERTY123"
    ]
}

Properties

add: Type: array add

Additional Properties Allowed:

Array of words to add into customer's specific restricted words not to be used as a password.
delete: Type: array delete

Additional Properties Allowed:

Array of words to delete from customer's specific restricted words not to be used as a password.

Nested Schema : add

Type: array

Array of words to add into customer's specific restricted words not to be used as a password.

Items

Type: string

Nested Schema : delete

Type: array

Array of words to delete from customer's specific restricted words not to be used as a password.

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateRestrictedWords_response

Properties

items: Type: array items

Additional Properties Allowed:

Array of customer's specific restricted words not to be used as a password.

Nested Schema : items

Type: array

Array of customer's specific restricted words not to be used as a password.

Items

Type: string

Example application/json


{
    "items":[
        "Admin123",
        "Password123"
    ]
}

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 Request:

{
  "add": [
    "Admin123",
    "Password123"
  ],
  "delete": [
    "Password",
    "QWERTY123"
  ]
}

Sample Response Payload returned by endpoint:

{"items": [
  "Admin123",
  "Password123"
]}