Jump to

• Request
• Response

OpenID Single Sign On

post

/ccadmin/v1/openid/sso

Request

Supported Media Types

• application/json

Body ()

Root Schema : openIDSingleSignOn_request

Type: object

Show Source

• authz_code: string
  The Authorization code returned from IDP
• code_verifier(optional): string
  The verifier code to retrieve token from IDP

{
    "properties":{
        "authz_code":{
            "description":"The Authorization code returned from IDP",
            "type":"string"
        },
        "code_verifier":{
            "description":"The verifier code to retrieve token from IDP",
            "type":"string"
        }
    },
    "required":[
        "authz_code"
    ],
    "example":{
        "authz_code":"AQIDBAXEoj8VshMPKEySZ7_oOa7_gg1vEMcG629nTqVDz3VZx2Ro1RbffWEwtRroC-DSg-gNyADxwXAArmmspD6XlDZ0MTEgRU5DUllQVElPTl9LRVkxNCB7djF9NCA=",
        "code_verifier":"NjOZ278Qe9GGzJhUmKfDAC9BAN4jrxOFKSnC00Eq.vSZYoQ1FdQmfxC7TY"
    }
}

Example:

{
    "authz_code":"AQIDBAXEoj8VshMPKEySZ7_oOa7_gg1vEMcG629nTqVDz3VZx2Ro1RbffWEwtRroC-DSg-gNyADxwXAArmmspD6XlDZ0MTEgRU5DUllQVElPTl9LRVkxNCB7djF9NCA=",
    "code_verifier":"NjOZ278Qe9GGzJhUmKfDAC9BAN4jrxOFKSnC00Eq.vSZYoQ1FdQmfxC7TY"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : openIDSingleSignOn_response

Type: object

Show Source

• access_token(optional): string
  The access token from IDP
• expires_in(optional): integer
  The token expire time in seconds
• refresh_token(optional): string
  The refresh token from IDP
• token_type(optional): string
  The access token type

{
    "properties":{
        "access_token":{
            "description":"The access token from IDP",
            "type":"string"
        },
        "refresh_token":{
            "description":"The refresh token from IDP",
            "type":"string"
        },
        "token_type":{
            "description":"The access token type",
            "type":"string"
        },
        "expires_in":{
            "description":"The token expire time in seconds",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MTQxNDk5NTYsInN1YiI6IjExMDU1OCIsImlzcyI6InN0b3JlZnJvbnRVSSIsImlhdCI6MTQxNDE0OTAyNn0=.B9qM0/VKpCNKvjCmOnUPv4RS7mkIDgKcP8RJPaVQGYU=",
    "refresh_token":"AQIDBAXlI-00TPsdgV2dpt3yZRjyyDBzCOP5Qkryo7O8mDqNNLpDPp5c0qHKB2Sq1Kjx_v1SuPS0rvtE1LDGIRKKoRZkMTEgRU5DUllQVElPTl9LRVkxNCB7djF9NCA=",
    "token_type":"bearer",
    "expires_in":3600
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |52301|Internal Error.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top