REST API for Oracle Commerce Cloud December 2017

samlAuthnRequest

post

/ccstore/v1/samlAuthnRequest

Saml Authn Request. Create a SAML AuthnRequest

Supported Media Types

Body Parameter

Root Schema : samlAuthnRequest_request

POST /ccstoreui/v1/samlAuthnRequest?encode=true

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : samlAuthnRequest_response

authnRequest: Type: string

A SAML AuthnRequest. If encode is true, it will be Base64 encoded.
authnRequestTarget: Type: string

The URL that the request should be posted to.


{
    "authnRequestTarget ":"http://localhost/idp/auth",
    "authnRequest ":"Base64 encoded SAML AuthnRequest"
}

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

POST /ccstoreui/v1/samlAuthnRequest?encode=true

Sample Response Payload returned by endpoint:

{
  "authnRequestTarget ": "http://localhost/idp/auth",
  "authnRequest ": "Base64 encoded SAML AuthnRequest"
}