{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses OIDC Authentication API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "OIDC Authentication", "type": "folder" }, "items": [ { "info": { "name": "Initiate OIDC Login", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/oidc-idp/login/stores/:storeId/authentication-realms/:realmId", "params": [ { "name": "storeId", "value": "", "type": "path", "description": "The ID of the store." }, { "name": "realmId", "value": "", "type": "path", "description": "The ID of the authentication realm." }, { "name": "client_id", "value": "", "type": "query", "description": "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)." }, { "name": "redirect_uri", "value": "", "type": "query", "description": "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)." }, { "name": "response_type", "value": "", "type": "query", "description": "OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce." }, { "name": "scope", "value": "", "type": "query", "description": "Space-delimited list of scopes. Must include \"openid\", \"email\", and \"name\"." }, { "name": "state", "value": "", "type": "query", "description": "Opaque value used to maintain state between the request and the callback. Helps prevent CSRF." }, { "name": "code_challenge_method", "value": "S256", "type": "query", "description": "[Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge." }, { "name": "code_challenge", "value": "", "type": "query", "description": "[Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge." }, { "name": "prompt", "value": "", "type": "query", "description": "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)." }, { "name": "display", "value": "", "type": "query", "description": "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)." }, { "name": "ui_locales", "value": "fr-CA fr en", "type": "query", "description": "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)." }, { "name": "elasticpath_commerce_cloud_profile_id", "value": "", "type": "query", "description": "Selects the specific OIDC Profile within the realm to use for authentication." }, { "name": "ep_report_callback_replay_error", "value": "", "type": "query", "description": "Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front" } ] }, "docs": "Initiate the OIDC login flow for a specific store and authentication realm\n::: note This is not an **API Endpoint**, but the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) of the OpenID Connect Authentication Flow.\nTo initiate an OpenID Connect authentication you must change the location in the Browser to this URL, not call it asynchronously. :::" }, { "info": { "name": "OpenID Connect Discovery", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/oidc-idp/stores/:storeId/authentication-realms/:realmId/.well-known/openid-configuration", "params": [ { "name": "storeId", "value": "", "type": "path", "description": "The ID of the store." }, { "name": "realmId", "value": "", "type": "path", "description": "The ID of the authentication realm." }, { "name": "elasticpath_commerce_cloud_profile_id", "value": "", "type": "query", "description": "The ID of the [OIDC profile](/docs/api/single-sign-on/oidc-profiles) that you would like to authenticate with" } ] }, "docs": "Returns the OpenID Connect discovery document for the authentication realm.\nThis endpoint provides metadata about the OIDC provider's configuration, including endpoints, supported features, and capabilities. Some libraries might require an OIDC discovery document in order to work.\nFor more information see [OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html)" } ] } ], "bundled": true }