Jump to

• Request
• Response

update Admin OpenID IDP settings

put

/ccadmin/v1/openid/metadata/idpSettings

Update Admin OpenID IDP settings.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateAdminOpenIDIdPSettings_request

Type: object

Show Source

• admin_app_client_id: string
  The client id of the OCCS Admin App registered in IDP
• admin_app_client_secret: string
  The client secret of the OCCS Admin App registered in IDP
• agent_app_client_id: string
  The client id of the OCCS Agent App registered in IDP
• agent_app_client_secret: string
  The client secret of the OCCS Agent App registered in IDP
• idp_base_url: string
  The base URL of IDP.

{
    "properties":{
        "agent_app_client_secret":{
            "description":"The client secret of the OCCS Agent App registered in IDP",
            "type":"string"
        },
        "admin_app_client_id":{
            "description":"The client id of the OCCS Admin App registered in IDP",
            "type":"string"
        },
        "idp_base_url":{
            "description":"The base URL of IDP.",
            "type":"string"
        },
        "admin_app_client_secret":{
            "description":"The client secret of the OCCS Admin App registered in IDP",
            "type":"string"
        },
        "agent_app_client_id":{
            "description":"The client id of the OCCS Agent App registered in IDP",
            "type":"string"
        }
    },
    "required":[
        "idp_base_url",
        "admin_app_client_id",
        "admin_app_client_secret",
        "agent_app_client_id",
        "agent_app_client_secret"
    ],
    "example":{
        "agent_app_client_secret":"8de85697-f5cb-4346-910d-453add786933",
        "admin_app_client_id":"3eec13c77e92421eac9ecf87fbea3b16",
        "idp_base_url":"https://cx-tenant02.identity.example.com",
        "admin_app_client_secret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
        "agent_app_client_id":"b3e03d5dc3254713a3c8bfd98e296cd2"
    }
}

Example:

{
    "agent_app_client_secret":"8de85697-f5cb-4346-910d-453add786933",
    "admin_app_client_id":"3eec13c77e92421eac9ecf87fbea3b16",
    "idp_base_url":"https://cx-tenant02.identity.example.com",
    "admin_app_client_secret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
    "agent_app_client_id":"b3e03d5dc3254713a3c8bfd98e296cd2"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateAdminOpenIDIdPSettings_response

Type: object

Show Source

• admin_app_client_id(optional): string
  The client id of the OCCS Admin App registered in IDP
• admin_app_client_secret(optional): string
  The client secret of the OCCS Admin App registered in IDP
• agent_app_client_id(optional): string
  The client id of the OCCS Agent App registered in IDP
• agent_app_client_secret(optional): string
  The client secret of the OCCS Agent App registered in IDP
• idp_base_url(optional): string
  The base URL of IDP.

{
    "properties":{
        "agent_app_client_secret":{
            "description":"The client secret of the OCCS Agent App registered in IDP",
            "type":"string"
        },
        "admin_app_client_id":{
            "description":"The client id of the OCCS Admin App registered in IDP",
            "type":"string"
        },
        "idp_base_url":{
            "description":"The base URL of IDP.",
            "type":"string"
        },
        "admin_app_client_secret":{
            "description":"The client secret of the OCCS Admin App registered in IDP",
            "type":"string"
        },
        "agent_app_client_id":{
            "description":"The client id of the OCCS Agent App registered in IDP",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "agent_app_client_secret":"8de85697-f5cb-4346-910d-453add786933",
    "admin_app_client_id":"3eec13c77e92421eac9ecf87fbea3b16",
    "idp_base_url":"https://cx-tenant02.identity.example.com",
    "admin_app_client_secret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
    "agent_app_client_id":"b3e03d5dc3254713a3c8bfd98e296cd2"
}

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| |------------------|------------------| |52300|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