updateOpenIDSettings

put

/ccadmin/v1/merchant/openidSettings

Update Storefront OpenID settings.

Request

Supported Media Types
Body ()
Root Schema : updateOpenIDSettings_request
Type: object
Show Source
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
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

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getOpenIDSettings_response
Type: object
Show Source
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
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
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