Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path OIDC Profiles API

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](/assets/oidc-profiles.png)

Elastic Path OIDC Profiles API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OIDC Profiles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path OIDC Profiles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

OIDC Profiles 5

An OpenID Connect Profile resource represents a specific configuration of an OpenID Connect Provider. An authentication realm can have multiple OpenID Connect Profiles. This allow…

POST
/v2/authentication-realms/{realmId}/oidc-profiles
Create an OIDC Profile
post-v2-authentication-realms-realmId-oidc-profiles 1 param body → 201400404422500
GET
/v2/authentication-realms/{realmId}/oidc-profiles
Get OIDC Profiles
get-v2-authentication-realms-realmId-oidc-profiles 3 params → 200404500
GET
/v2/authentication-realms/{realmId}/oidc-profiles/{profileId}
Get OIDC Profile
get-v2-authentication-realms-realmId-oidc-profiles-profileId 2 params → 200400404422500
PUT
/v2/authentication-realms/{realmId}/oidc-profiles/{profileId}
Update OIDC Profile
put-v2-authentication-realms-realmId-oidc-profiles-profileId 2 params body → 200400404422500
DELETE
/v2/authentication-realms/{realmId}/oidc-profiles/{profileId}
Delete OIDC Profile
delete-v2-authentication-realms-realmId-oidc-profiles-profileId 2 params → 204400404422500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PaginationLinks (6 properties), OidcProfile (5 properties), Error (3 properties), PaginationMeta (2 properties). Each schema is shown below with its type and property counts.

UUID
string
The unique identifier.
OidcProfileResponse
OidcProfileLinks
PaginationLinks
object
6 properties
Error
object
3 properties 2 required
SelfLink
object
1 property
OidcProfile
object
5 properties 2 required
PaginationMeta
object
2 properties
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-oidc-profiles-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API