updateSamlIdPSettings

put

/ccadmin/v1/samlIdentityProviders/{id}

Update Saml Id PSettings. Update the IdP settings.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateSamlIdPSettings_request
Type: object
Show Source
Example:
PUT /ccadminui/v1/samlIdentityProviders/default
Nested Schema : optionalAttributeToPropertyMap
Type: object
Additional Properties Allowed
Show Source
Map from SAML AuthnResponse Attribute names to commerce customer property names.
Nested Schema : requiredAttributeToPropertyMap
Type: object
Additional Properties Allowed
Show Source
Map from SAML AuthnResponse Attribute names to commerce customer property names.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateSamlIdPSettings_response
Type: object
Show Source
Nested Schema : optionalAttributeToPropertyMap
Type: object
Additional Properties Allowed
Show Source
Map from SAML AuthnResponse Attribute names to commerce customer property names.
Nested Schema : requiredAttributeToPropertyMap
Type: object
Additional Properties Allowed
Show Source
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
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top