REST API for Oracle Commerce Cloud December 2017

updateSamlSettings

put

/ccadmin/v1/merchant/samlSettings

Update Saml Settings. Update the SAML settings.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : updateSamlSettings_request

Example

PUT /ccadminui/v1/merchant/samlSettings

Properties

enabled: Type: boolean

is SAML SSO enabled
nameIdPolicyAllowCreate: Type: boolean

Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
nameIdPolicyFormat: Type: string

The nameIdPolicyFormat to use.
requireEncryptedAssertions: Type: boolean

If Auth Responses are required to have encrypted assertions.
requireSignedResponse: Type: boolean

If Auth Responses are required to be signed.
signAuthnRequest: Type: boolean

If AuthnRequest should be signed.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateSamlSettings_response

Properties

enabled: Type: boolean

is SAML SSO enabled
nameIdPolicyAllowCreate: Type: boolean

Controls the nameIdPolicyAllowCreate field of the AuthnRequest.
nameIdPolicyFormat: Type: string

The nameIdPolicyFormat to use.
requireEncryptedAssertions: Type: boolean

If Auth Responses are required to have encrypted assertions.
requireSignedResponse: Type: boolean

If Auth Responses are required to be signed.
signAuthnRequest: Type: boolean

If AuthnRequest should be signed.
spMetadata: Type: string

The base64 encoded SP Metadata.

Example application/json


{
    "nameIdPolicyFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
    "requireEncryptedAssertions":false,
    "requireSignedResponse":false,
    "signAuthnRequest":true,
    "spMetadata":"[Base64 encoded SP Metadata]",
    "nameIdPolicyAllowCreate":true,
    "enabled":true
}

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:

PUT /ccadminui/v1/merchant/samlSettings

Sample Response Payload returned by endpoint:

{
  "nameIdPolicyFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
  "requireEncryptedAssertions": false,
  "requireSignedResponse": false,
  "signAuthnRequest": true,
  "spMetadata": "[Base64 encoded SP Metadata]",
  "nameIdPolicyAllowCreate": true,
  "enabled": true
}