Elastic Path Authentication Realms API
An authentication realm is a container that consists of the following: - Users - Represented by [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos)objects - Authentication profiles - Ways for the users to authenticate, such as one or more [OpenID ConnectProfiles](/docs/api/single-sign-on/oidc-profiles) or [Password Profiles](/docs/api/single-sign-on/password-profiles) - Mappings between users and authentication profiles - [User Authentication OpenID Connect ProfileInfo](/docs/api/single-sign-on/user-authentication-oidc-profile-infos) or [User Authentication Password Profile Infos](/docs/api/single-sign-on/user-authentication-password-profile-infos)Here's a domain diagram showing these relationshipsComposable Commerce comes with three per-store pre-set realms: - Buyer Organization. For customers: users who buy products from your store. - Merchant Organization. For administrators: users who log in to Commerce Manager to modify thestore’s settings or catalog. - Account Management Realm. For account members: users who buy products from your store on behalfof accounts. Password profiles are only available for account management realm.
Elastic Path Authentication Realms 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 Authentication Realms. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 10 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Authentication Realms API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
An authentication realm is a container that consists of the following: - Users - Represented by [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) obje…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AuthenticationRealm (5 properties), MetaListPage (4 properties), Error (3 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.