Skip to main content

OpenID Connect Profiles

An OpenID Connect Profile resource represents a specific configuration of an OpenID Connect Provider.

An authentication realm can have multiple OpenID Connect Profiles. This allows shoppers to authenticate using multiple OpenID providers. In the example shown below, Jane can login using both Apple and Google, whereas Joan can only login using Google.

oidc profiles

The OpenID Connect Profile Object

client_idstringThe client id to be used with the external authentication provider
discovery_urlstringThe url of the OpenID Connect discovery document.
idstringThe unique identifier for this OpenID Connect profile.
metaobjectAdditional information for this realm. For more information, see The meta object below.
namestringThe name of the OpenID Connect profile.
typestringThe type represents the object being returned.
linksobjectRelated links. Also see: The links object below.

Sample Object

"data": {
"client_id": "openid-client",
"discovery_url": "",
"id": "ed83913b-d6dc-4472-9328-bb486443de9c",
"meta": {
"issuer": "",
"created_at": "2020-11-04T21:59:58.611Z",
"updated_at": "2020-11-04T21:59:58.611Z"
"name": "SSO Provider",
"type": "oidc-profile"
"links": {
"authorization-endpoint": "",
"callback-endpoint": "",
"client-discovery-url": "",
"self": ""

The meta Object

meta.issuerstringThe issuer from the discovery document of this OpenID Connect profile.
meta.created_atstringThe creation date of this OpenID Connect profile.
meta.updated_atstringThe last updated date of this OpenID Connect profile.
links.authorization-endpointstringThe link that front-end applications should use to authenticate the OpenID Connect profile. The front-end application is responsible for appending all of the required parameters to the request. The endpoint also forwards some optional parameters, display, prompt and ui_locales to the configured Identity Provider. These parameters allow you to control the behavior of the authentication process on the Identity Provider.
links.callback-endpointstringThe link that should be supplied as the callback URL to the upstream authentication provider.
links.client-discovery-urlstringThe link to the OpenID Connect Discovery document for this provider.