getPolicies

get

/ccadmin/v1/merchant/profilePolicies

Get Policies. Retrieves all the shopper policies

• Request
• Response
• Examples

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

Properties

blockCommonPasswords

Type: boolean

Block the Use of Commonly Chosen Passwords and Weak Passphrases.

cannotUsePreviousPasswords

Type: boolean

Applies the previous password usage constraint.

cannotUseUsername

Type: string

Password must not be the same as their Username.

guestCheckoutEnabled

Type: boolean

Applies the authorization for anonymous shoppers to sign-in to complete checkout.

minPasswordLength

Type: integer

Minimum length of the password.

minPasswordLengthMaxVal

Type: integer

Maximum value of minimum length of the password.

minPasswordLengthMinVal

Type: integer

Minimum value of minimum length of the password.

numberOfPreviousPasswords

Type: integer

password should not have been used as previous N passwords for the given shopper user.

numberOfPreviousPasswordsMaxVal

Type: integer

Maximum number of previous passwords to be stored for the given shopper user.

numberOfPreviousPasswordsMinVal

Type: integer

Minimum number of previous passwords to be stored for the given shopper user.

passwordExpirationEnabled

Type: boolean

Applies the password expiration constraint.

passwordExpirationLength

Type: integer

number of days after which the current password of the shopper will automatically expire.

passwordExpirationLengthMinVal

Type: integer

minimum number of days after which the current password of the shopper will automatically expire..

sessionTimeoutEnabled

Type: boolean

Applies the session timeout length constraint.

sessionTimeoutLength

Type: integer

Timeout duration for all shopper sessions.

sessionTimeoutLengthMaxVal

Type: integer

Maximum timeout length for the user session.

sessionTimeoutLengthMinVal

Type: integer

Minimum timeout length for the user session.

useCase

Type: boolean

Applies the usage of capital letters in user password..

useMinPasswordLength

Type: boolean

Applies the minimum password length constraint.

useNumber

Type: boolean

Password must include a number.

useSymbol

Type: boolean

Applies the usage of symbol in user password.

Example application/json

{
    "guestCheckoutEnabled":true,
    "numberOfPreviousPasswords":3,
    "numberOfPreviousPasswordsMinVal":1,
    "passwordExpirationEnabled":false,
    "passwordExpirationLengthMinVal":1,
    "sessionTimeoutLength":15,
    "cannotUsePreviousPasswords":false,
    "passwordExpirationLength":90,
    "minPasswordLengthMinVal":4,
    "sessionTimeoutEnabled":true,
    "minPasswordLengthMaxVal":64,
    "useNumber":true,
    "useCase":false,
    "cannotUseUsername":true,
    "useMinPasswordLength":true,
    "minPasswordLength":8,
    "numberOfPreviousPasswordsMaxVal":6,
    "blockCommonPasswords":true,
    "sessionTimeoutLengthMinVal":1,
    "sessionTimeoutLengthMaxVal":120,
    "useSymbol":false
}

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:

{
  "guestCheckoutEnabled": true,
  "numberOfPreviousPasswords": 3,
  "numberOfPreviousPasswordsMinVal": 1,
  "passwordExpirationEnabled": false,
  "passwordExpirationLengthMinVal": 1,
  "sessionTimeoutLength": 15,
  "cannotUsePreviousPasswords": false,
  "passwordExpirationLength": 90,
  "minPasswordLengthMinVal": 4,
  "sessionTimeoutEnabled": true,
  "minPasswordLengthMaxVal": 64,
  "useNumber": true,
  "useCase": false,
  "cannotUseUsername": true,
  "useMinPasswordLength": true,
  "minPasswordLength": 8,
  "numberOfPreviousPasswordsMaxVal": 6,
  "blockCommonPasswords": true,
  "sessionTimeoutLengthMinVal": 1,
  "sessionTimeoutLengthMaxVal": 120,
  "useSymbol": false
}