REST API for Oracle Commerce Cloud 21C

updateSamlIdPSettings

put

/ccadmin/v1/samlIdentityProviders/{id}

Update Saml Id PSettings. Update the IdP settings.

Request

Supported Media Types

application/json

Path Parameters

id: string

Id of IdP.

Root Schema : updateSamlIdPSettings_request

Type: object

Show Source

emailAttributeName(optional): string

The name of the attribute that should map to the commerce customer email address.
encodedIdpMetadata(optional): string

The base64 encoded SAML IdP Entity Descriptor XML.
loginAttributeName(optional): string

The name of the attribute that should map to the commerce customer login name.
optionalAttributeToPropertyMap(optional): object optionalAttributeToPropertyMap

Additional Properties Allowed: additionalProperties

Map from SAML AuthnResponse Attribute names to commerce customer property names.
requiredAttributeToPropertyMap(optional): object requiredAttributeToPropertyMap

Additional Properties Allowed: additionalProperties

Map from SAML AuthnResponse Attribute names to commerce customer property names.

{
    "properties":{
        "loginAttributeName":{
            "description":"The name of the attribute that should map to the commerce customer login name.",
            "type":"string"
        },
        "emailAttributeName":{
            "description":"The name of the attribute that should map to the commerce customer email address.",
            "type":"string"
        },
        "encodedIdpMetadata":{
            "description":"The base64 encoded SAML IdP Entity Descriptor XML.",
            "type":"string"
        },
        "requiredAttributeToPropertyMap":{
            "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "optionalAttributeToPropertyMap":{
            "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        }
    },
    "example":"PUT /ccadminui/v1/samlIdentityProviders/default"
}

Example:

PUT /ccadminui/v1/samlIdentityProviders/default

Nested Schema : optionalAttributeToPropertyMap

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map from SAML AuthnResponse Attribute names to commerce customer property names.

Nested Schema : requiredAttributeToPropertyMap

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map from SAML AuthnResponse Attribute names to commerce customer property names.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : updateSamlIdPSettings_response

Type: object

Show Source

encodedIdpMetadata(optional): string

The base64 encoded SAML IdP Entity Descriptor XML.
fallbackToB2cUserCreation(optional): boolean

Flag to enable control the B2C user creation if IDP does not provide any account for the authenticated user.
loginAttributeName(optional): string

The name of the attribute that should map to the commerce customer login name.
optionalAttributeToPropertyMap(optional): object optionalAttributeToPropertyMap

Additional Properties Allowed: additionalProperties

Map from SAML AuthnResponse Attribute names to commerce customer property names.
organizationAttributeName(optional): string

Map from SAML AuthnResponse Organization Attribute name to commerce organization name.
requiredAttributeToPropertyMap(optional): object requiredAttributeToPropertyMap

Additional Properties Allowed: additionalProperties

Map from SAML AuthnResponse Attribute names to commerce customer property names.
roleAttributeName(optional): string

Map from SAML AuthnResponse Roles list Attribute name to commerce customer's roles list property name.

{
    "properties":{
        "roleAttributeName":{
            "description":"Map from SAML AuthnResponse Roles list Attribute name to commerce customer's roles list property name.",
            "type":"string"
        },
        "organizationAttributeName":{
            "description":"Map from SAML AuthnResponse Organization Attribute name to commerce organization name.",
            "type":"string"
        },
        "loginAttributeName":{
            "description":"The name of the attribute that should map to the commerce customer login name.",
            "type":"string"
        },
        "encodedIdpMetadata":{
            "description":"The base64 encoded SAML IdP Entity Descriptor XML.",
            "type":"string"
        },
        "fallbackToB2cUserCreation":{
            "description":"Flag to enable control the B2C user creation if IDP does not provide any account for the authenticated user.",
            "type":"boolean"
        },
        "requiredAttributeToPropertyMap":{
            "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "optionalAttributeToPropertyMap":{
            "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        }
    }
}

Nested Schema : optionalAttributeToPropertyMap

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map from SAML AuthnResponse Attribute names to commerce customer property names.

Nested Schema : requiredAttributeToPropertyMap

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Map from SAML AuthnResponse Attribute names to commerce customer property names.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map from SAML AuthnResponse Attribute names to commerce customer property names.

Example Response (application/json)

{
    "loginAttributeName":"uid",
    "emailAttributeName":"email",
    "encodedIdpMetadata":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVudGl0eURlc2NyaXB0b3IgZW50aXR5SUQ9Imh0dHA6Ly9sb2NhbGhvc3Q6NzA4MC9hdXRoL3JlYWxtcy9tYXN0ZXIiCiAgICAgICAgICAgICAgICAgICB4bWxucz0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm1ldGFkYXRhIgogICAgICAgICAgICAgICAgICAgeG1sbnM6eHNpPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSI+CiAgIDxJRFBTU09EZXNjcmlwdG9yIFdhbnRBdXRoblJlcXVlc3RzU2lnbmVkPSJ0cnVlIgogICAgICBwcm90b2NvbFN1cHBvcnRFbnVtZXJhdGlvbj0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOnByb3RvY29sIj4KICAgPE5hbWVJREZvcm1hdD51cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6bmFtZWlkLWZvcm1hdDpwZXJzaXN0ZW50PC9OYW1lSURGb3JtYXQ+CiAgIDxOYW1lSURGb3JtYXQ+dXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm5hbWVpZC1mb3JtYXQ6dHJhbnNpZW50PC9OYW1lSURGb3JtYXQ+CiAgIDxOYW1lSURGb3JtYXQ+dXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6MS4xOm5hbWVpZC1mb3JtYXQ6dW5zcGVjaWZpZWQ8L05hbWVJREZvcm1hdD4KICAgPE5hbWVJREZvcm1hdD51cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoxLjE6bmFtZWlkLWZvcm1hdDplbWFpbEFkZHJlc3M8L05hbWVJREZvcm1hdD4KCiAgICAgIDxTaW5nbGVTaWduT25TZXJ2aWNlIEJpbmRpbmc9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpiaW5kaW5nczpIVFRQLVBPU1QiCiAgICAgICAgIExvY2F0aW9uPSJodHRwOi8vbG9jYWxob3N0OjcwODAvYXV0aC9yZWFsbXMvbWFzdGVyL3Byb3RvY29sL3NhbWwiIC8+CiAgICAgIDxTaW5nbGVMb2dvdXRTZXJ2aWNlCiAgICAgICAgIEJpbmRpbmc9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpiaW5kaW5nczpIVFRQLVBPU1QiCiAgICAgICAgIExvY2F0aW9uPSJodHRwOi8vbG9jYWxob3N0OjcwODAvYXV0aC9yZWFsbXMvbWFzdGVyL3Byb3RvY29sL3NhbWwiIC8+CiAgICAgIDxLZXlEZXNjcmlwdG9yIHVzZT0ic2lnbmluZyI+CiAgICAgICAgICA8ZHNpZzpLZXlJbmZvIHhtbG5zOmRzaWc9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkveG1sZHNpZyMiPgogICAgICAgICAgICAgIDxkc2lnOlg1MDlEYXRhPgogICAgICAgICAgICAgICAgICA8ZHNpZzpYNTA5Q2VydGlmaWNhdGU+CiAgICAgICAgICAgICAgICAgICAgICBNSUlDbXpDQ0FZTUNCZ0ZYVW5Mc05EQU5CZ2txaGtpRzl3MEJBUXNGQURBUk1ROHdEUVlEVlFRRERBWnRZWE4wWlhJd0hoY05NVFl3T1RJeU1UVXdPVEExV2hjTk1qWXdPVEl5TVRVeE1EUTFXakFSTVE4d0RRWURWUVFEREFadFlYTjBaWEl3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ01aK0UyNk80YXRrUEpaSVNZMjI5bFBqSm0xNis2NzZjUFlpeXVuYXhLcDdMUFBVMlVkQVI4U3RmdEw1QkY1UUx1ZUtQMFZRaDRubmRKeHN0eFhVSUVnVHUrb3h1dklGb3E0U2srWUhXSXZHWnVKS2o2VWovRm96UW1Rd2tlVyt6WVp1emdyeWpvKzJqUFlPaVl0OWNyTzcxTzJacmFSakJMU1p0NlFNbUkwd0Y2VllDMkxkbjU3ZUhraWYyaStYL2dzc1RqblVvTVJUcGU4MzZnU2E5eHgwaFp5V2N6QStjMnNwaitnNHNZaEtWRExpSk9aZ3BybmF3MUVJQ1dMbDhzVVZFdm1hUDczMkFuTHNwVVBVa2U3NkxHUWtOTmRmRkpzcXpGQlhuVTdIaHIwaDJGeG8xR1dpSDJNWkNCU3M5dnpmZWNUR2ZkTGhWOGxXdHFGcVQxQWdNQkFBRXdEUVlKS29aSWh2Y05BUUVMQlFBRGdnRUJBR3VycWtlOXg3UzhXSWtxVDBXT3YwUXd6ckJsY0tNc1hSMVFhTTFxS2pnTWhUUm5xcVBEN1pVSitHbEVDRkt1L1ZBczNITTlZYlk1aGtNeHhXSlBIQ1hyOFVQMDNHbmZIZENhOVFXdHdsdkJ0WmVDWVNPbW1QUGhUcGxOSlZqdTZPRjd0Nm9XRGh2NTZZVlhIc3VpNk42K0VkeU9iaU1idHc0ZWl0TEpyNzZ4UGlKWGpnNHdIQTltSWpzcitIbkVzQ1YwTStuSnlqZERUTEE0UUxBcmxDQjZsalNoT3J2VndmZXdDN0ZIOWdjTGJQTnhTdnZFTXJLeStZcVpJTi9tbzdBMW91d2tZUXVOWDNWVjhDTXN2RkcrbDJsZVBRenBhRHJteVk0Z0MrR25obVVQNm5teHcraGprN3k2eGhOcTZtQXdxZzJrL0JkcXpjQTRZbCszSXlNPQogICAgICAgICAgICAgICAgICA8L2RzaWc6WDUwOUNlcnRpZmljYXRlPgogICAgICAgICAgICAgIDwvZHNpZzpYNTA5RGF0YT4KICAgICAgICAgIDwvZHNpZzpLZXlJbmZvPgogICAgICA8L0tleURlc2NyaXB0b3I+CiAgIDwvSURQU1NPRGVzY3JpcHRvcj4KPC9FbnRpdHlEZXNjcmlwdG9yPgo=",
    "requiredAttributeToPropertyMap":{
        "uid":"login",
        "email":"email"
    },
    "optionalAttributeToPropertyMap":{
        "lastName":"lastName"
    }
}

Default Response

The error response

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"
        }
    }
}