younifyd
Menu

Get Oidc Idp Login Stores Store Id Authentication Realms Realm Id

Initiate OIDC Login

GET/oidc-idp/login/stores/{storeId}/authentication-realms/{realmId}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Oidc Idp Login Stores Store Id Authentication Realms Realm Id action (under Single Sign-On).
  3. Fill in the fields below, then reference the result from later steps as {{getOidcIdpLoginStoresStoreIdAuthenticationRealmsRealmId.response.data}}.

Request

Path parameters

storeIdstring (uuid)required

The ID of the store.

realmIdstring (uuid)required

The ID of the authentication realm.

Query parameters

client_idstringrequired

The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication).

redirect_uristring (uri)required

Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI for the client in the `redirect_uris` of the [Authentication Realm](/docs/api/single-sign-on/get-v-2-authentication-realms-realm-id).

response_typestringrequired

OIDC/OAuth 2.0 response type, this must be "code" in Commerce.

scopestringrequired

Space-delimited list of scopes. Must include "openid", "email", and "name".

statestringrequired

Opaque value used to maintain state between the request and the callback. Helps prevent CSRF.

code_challenge_methodstringrequired

[Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge.

One ofS256plain

code_challengestringrequired

[Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge.

promptstring

Space-delimited, case-sensitive list that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).

displaystring

ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).

ui_localesstring

End-User's preferred languages and scripts for the user interface, represented as space-separated list of BCP47 language tag values. This value is forwarded to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).

elasticpath_commerce_cloud_profile_idstring (uuid)required

Selects the specific OIDC Profile within the realm to use for authentication.

ep_report_callback_replay_errorboolean

Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Get Oidc Idp Login Stores Store Id Authentication Realms Realm Id — Elastic Path — Documentation