Jump to

• Request
• Response

updateOpenIDSettings

put

/ccadmin/v1/merchant/openidSettings

Update Storefront OpenID settings.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateOpenIDSettings_request

Type: object

Show Source

• baseURL(required): string
  The base URL of the identity provider. Either baseURL or openidConfiguration must be provided.
• clientId(required): string
  The client ID of the identity provider application.
• clientSecret(required): string
  The client secret of the identity provider application.
• emailClaimName: string
  The name of the user information claim mapped to the profile email property.
• enabled: boolean
  Whether to enable OpenID Connect on Storefront.
• loginClaimName: string
  The name of the user information claim mapped to the profile login property.
• openidConfiguration(required): object openidConfiguration
  Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.
• optionalClaimToProfilePropertyMap: object optionalClaimToProfilePropertyMap
  The mapping from user information claims to optional profile properties.
• organizationClaimName: string
  The name of the organization ID claim.
• requiredClaimToProfilePropertyMap: object requiredClaimToProfilePropertyMap
  The mapping from user information claims to required profile properties.
• roleClaimName: string
  The name of the role ID claim.

{
    "properties":{
        "baseURL":{
            "description":"The base URL of the identity provider. Either baseURL or openidConfiguration must be provided.",
            "type":"string"
        },
        "loginClaimName":{
            "description":"The name of the user information claim mapped to the profile login property.",
            "type":"string"
        },
        "emailClaimName":{
            "description":"The name of the user information claim mapped to the profile email property.",
            "type":"string"
        },
        "clientId":{
            "description":"The client ID of the identity provider application.",
            "type":"string"
        },
        "openidConfiguration":{
            "description":"Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.",
            "type":"object",
            "properties":{
                "jwks_uri":{
                    "description":"The URL of the authorization server's JSON Web Key Set document.",
                    "type":"string"
                },
                "end_session_endpoint":{
                    "description":"The URL of the authorization server's logout endpoint.",
                    "type":"string"
                },
                "issuer":{
                    "description":"The authorization server's issuer identifier.",
                    "type":"string"
                },
                "authorization_endpoint":{
                    "description":"The URL of the authorization server's authorization endpoint.",
                    "type":"string"
                },
                "token_endpoint":{
                    "description":"The URL of the authorization server's token endpoint.",
                    "type":"string"
                },
                "userinfo_endpoint":{
                    "description":"he URL of the authorization server's user information endpoint.",
                    "type":"string"
                }
            },
            "required":[
                "authorization_endpoint",
                "token_endpoint",
                "end_session_endpoint",
                "userinfo_endpoint",
                "jwks_uri",
                "issuer"
            ]
        },
        "organizationClaimName":{
            "description":"The name of the organization ID claim.",
            "type":"string"
        },
        "clientSecret":{
            "description":"The client secret of the identity provider application.",
            "type":"string"
        },
        "requiredClaimToProfilePropertyMap":{
            "description":"The mapping from user information claims to required profile properties.",
            "type":"object"
        },
        "roleClaimName":{
            "description":"The name of the role ID claim.",
            "type":"string"
        },
        "enabled":{
            "description":"Whether to enable OpenID Connect on Storefront.",
            "type":"boolean"
        },
        "optionalClaimToProfilePropertyMap":{
            "description":"The mapping from user information claims to optional profile properties.",
            "type":"object"
        }
    },
    "required":[
        "baseURL",
        "clientId",
        "clientSecret",
        "openidConfiguration"
    ],
    "example":{
        "baseURL":"https://cx-tenant02.identity.example.com",
        "loginClaimName":"login",
        "emailClaimName":"email",
        "clientId":"3eec13c77e92421eac9ecf87fbea3b16",
        "organizationClaimName":"organization_id",
        "clientSecret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
        "requiredClaimToProfilePropertyMap":{
            "sub":"login",
            "email":"email"
        },
        "roleClaimName":"role_id",
        "enabled":true,
        "optionalClaimToProfilePropertyMap":{
            "given_name":"firstName",
            "family_name":"lastName"
        }
    }
}

Example:

{
    "baseURL":"https://cx-tenant02.identity.example.com",
    "loginClaimName":"login",
    "emailClaimName":"email",
    "clientId":"3eec13c77e92421eac9ecf87fbea3b16",
    "organizationClaimName":"organization_id",
    "clientSecret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
    "requiredClaimToProfilePropertyMap":{
        "sub":"login",
        "email":"email"
    },
    "roleClaimName":"role_id",
    "enabled":true,
    "optionalClaimToProfilePropertyMap":{
        "given_name":"firstName",
        "family_name":"lastName"
    }
}

Nested Schema : openidConfiguration

Type: object

Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.

Show Source

• authorization_endpoint(required): string
  The URL of the authorization server's authorization endpoint.
• end_session_endpoint(required): string
  The URL of the authorization server's logout endpoint.
• issuer(required): string
  The authorization server's issuer identifier.
• jwks_uri(required): string
  The URL of the authorization server's JSON Web Key Set document.
• token_endpoint(required): string
  The URL of the authorization server's token endpoint.
• userinfo_endpoint(required): string
  he URL of the authorization server's user information endpoint.

{
    "description":"Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.",
    "type":"object",
    "properties":{
        "jwks_uri":{
            "description":"The URL of the authorization server's JSON Web Key Set document.",
            "type":"string"
        },
        "end_session_endpoint":{
            "description":"The URL of the authorization server's logout endpoint.",
            "type":"string"
        },
        "issuer":{
            "description":"The authorization server's issuer identifier.",
            "type":"string"
        },
        "authorization_endpoint":{
            "description":"The URL of the authorization server's authorization endpoint.",
            "type":"string"
        },
        "token_endpoint":{
            "description":"The URL of the authorization server's token endpoint.",
            "type":"string"
        },
        "userinfo_endpoint":{
            "description":"he URL of the authorization server's user information endpoint.",
            "type":"string"
        }
    },
    "required":[
        "authorization_endpoint",
        "token_endpoint",
        "end_session_endpoint",
        "userinfo_endpoint",
        "jwks_uri",
        "issuer"
    ]
}

Nested Schema : optionalClaimToProfilePropertyMap

Type: object

The mapping from user information claims to optional profile properties.

Nested Schema : requiredClaimToProfilePropertyMap

Type: object

The mapping from user information claims to required profile properties.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getOpenIDSettings_response

Type: object

Show Source

• baseURL: string
  The base URL of the identity provider. Either baseURL or openidConfiguration must be provided.
• clientId: string
  The client ID of the identity provider application.
• clientSecret: string
  The client secret of the identity provider application.
• emailClaimName: string
  The name of the user information claim mapped to the profile email property.
• enabled: boolean
  Whether to enable OpenID Connect on Storefront.
• loginClaimName: string
  The name of the user information claim mapped to the profile login property.
• openidConfiguration: object openidConfiguration
  Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.
• optionalClaimToProfilePropertyMap: object optionalClaimToProfilePropertyMap
  The mapping from user information claims to optional profile properties.
• organizationClaimName: string
  The name of the organization ID claim.
• requiredClaimToProfilePropertyMap: object requiredClaimToProfilePropertyMap
  The mapping from user information claims to required profile properties.
• roleClaimName: string
  The name of the role ID claim.

{
    "properties":{
        "baseURL":{
            "description":"The base URL of the identity provider. Either baseURL or openidConfiguration must be provided.",
            "type":"string"
        },
        "loginClaimName":{
            "description":"The name of the user information claim mapped to the profile login property.",
            "type":"string"
        },
        "emailClaimName":{
            "description":"The name of the user information claim mapped to the profile email property.",
            "type":"string"
        },
        "clientId":{
            "description":"The client ID of the identity provider application.",
            "type":"string"
        },
        "openidConfiguration":{
            "description":"Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.",
            "type":"object",
            "properties":{
                "jwks_uri":{
                    "description":"The URL of the authorization server's JSON Web Key Set document.",
                    "type":"string"
                },
                "end_session_endpoint":{
                    "description":"The URL of the authorization server's logout endpoint.",
                    "type":"string"
                },
                "issuer":{
                    "description":"The authorization server's issuer identifier.",
                    "type":"string"
                },
                "authorization_endpoint":{
                    "description":"The URL of the authorization server's authorization endpoint.",
                    "type":"string"
                },
                "token_endpoint":{
                    "description":"The URL of the authorization server's token endpoint.",
                    "type":"string"
                },
                "userinfo_endpoint":{
                    "description":"he URL of the authorization server's user information endpoint.",
                    "type":"string"
                }
            }
        },
        "organizationClaimName":{
            "description":"The name of the organization ID claim.",
            "type":"string"
        },
        "clientSecret":{
            "description":"The client secret of the identity provider application.",
            "type":"string"
        },
        "requiredClaimToProfilePropertyMap":{
            "description":"The mapping from user information claims to required profile properties.",
            "type":"object"
        },
        "roleClaimName":{
            "description":"The name of the role ID claim.",
            "type":"string"
        },
        "enabled":{
            "description":"Whether to enable OpenID Connect on Storefront.",
            "type":"boolean"
        },
        "optionalClaimToProfilePropertyMap":{
            "description":"The mapping from user information claims to optional profile properties.",
            "type":"object"
        }
    }
}

Nested Schema : openidConfiguration

Type: object

Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.

Show Source

• authorization_endpoint: string
  The URL of the authorization server's authorization endpoint.
• end_session_endpoint: string
  The URL of the authorization server's logout endpoint.
• issuer: string
  The authorization server's issuer identifier.
• jwks_uri: string
  The URL of the authorization server's JSON Web Key Set document.
• token_endpoint: string
  The URL of the authorization server's token endpoint.
• userinfo_endpoint: string
  he URL of the authorization server's user information endpoint.

{
    "description":"Direct links to authorization server endpoints. It can be used if .well-known/openid-configuration is not supported. Either baseURL or openidConfiguration must be provided.",
    "type":"object",
    "properties":{
        "jwks_uri":{
            "description":"The URL of the authorization server's JSON Web Key Set document.",
            "type":"string"
        },
        "end_session_endpoint":{
            "description":"The URL of the authorization server's logout endpoint.",
            "type":"string"
        },
        "issuer":{
            "description":"The authorization server's issuer identifier.",
            "type":"string"
        },
        "authorization_endpoint":{
            "description":"The URL of the authorization server's authorization endpoint.",
            "type":"string"
        },
        "token_endpoint":{
            "description":"The URL of the authorization server's token endpoint.",
            "type":"string"
        },
        "userinfo_endpoint":{
            "description":"he URL of the authorization server's user information endpoint.",
            "type":"string"
        }
    }
}

Nested Schema : optionalClaimToProfilePropertyMap

Type: object

The mapping from user information claims to optional profile properties.

Nested Schema : requiredClaimToProfilePropertyMap

Type: object

The mapping from user information claims to required profile properties.

Example Response (application/json)

{
    "baseURL":"https://cx-tenant02.identity.example.com",
    "loginClaimName":"login",
    "emailClaimName":"email",
    "clientId":"3eec13c77e92421eac9ecf87fbea3b16",
    "organizationClaimName":"organization_id",
    "clientSecret":"1e24b226-0436-4c6b-9692-a6fe7fee37d7",
    "requiredClaimToProfilePropertyMap":{
        "sub":"login",
        "email":"email"
    },
    "roleClaimName":"role_id",
    "optionalClaimToProfilePropertyMap":{
        "given_name":"firstName",
        "family_name":"lastName"
    }
}

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.| |52301|Internal IDP error.| |52302|One of the following properties is required: baseURL, openidConfiguration| |52303|Ambiguous configuration. Only one of the following properties is required: baseURL, openidConfiguration| |52306|IDP configuration error.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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