REST API for Oracle Commerce Cloud December 2017

getRestrictedWords

get

/ccadmin/v1/merchant/profilePolicies/restrictedWords

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

There are no request parameters for this operation.

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getRestrictedWords_response

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":[
        "Admin123",
        "Password123"
    ]
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

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

Nested Schema : items

Type: object

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

Sample Response Payload returned by endpoint:

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