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 Password Profiles API

A `password_profile` resource represents a specific configuration that allows users to authenticate through username and password.Password Profiles support One-Time Password Tokens, which can be used to use passwordless login or password reset.An authentication realm can have multiple Password Profiles. You can use this flexibility in many ways. For instance, if you want to migrate an existing pool of users from another system with their own usernames and passwords, they can use one profile, while the rest of the users use another.Another use case is enabling shopper impersonation, where shoppers can authenticate using their own username and password in one profile. Meanwhile, admins can have a different username and password for the same user in a separate profile, shown as the "Impersonation Profile". This process can be automated using a Backend-For-Frontend (BFE) or One-Time Password Tokens. In the example shown below, both John and Joan can log in with their credentials, and an admin can also log in as Joan using the "Impersonation Profile".![password profiles](/assets/password-profiles.png)

Elastic Path Password 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 Password Profiles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 11 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.

6 operations 3 paths 11 schemas 1 DELETE2 GET2 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 Password Profiles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 6

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

Password Profiles 6

A passwordprofile resource represents a specific configuration that allows users to authenticate through username and password. Password Profiles support One-Time Password Tokens,…

GET
/v2/authentication-realms/{realmId}/password-profiles
Get Password Profiles
get-v2-authentication-realms-realmId-password-profiles 3 params → 200404500
POST
/v2/authentication-realms/{realmId}/password-profiles
Create Password Profile
post-v2-authentication-realms-realmId-password-profiles 1 param body → 201400404422500
GET
/v2/authentication-realms/{realmId}/password-profiles/{profileId}
Get Password Profile
get-v2-authentication-realms-realmId-password-profiles-profileId 2 params → 200400404422500
PUT
/v2/authentication-realms/{realmId}/password-profiles/{profileId}
Update Password Profile
put-v2-authentication-realms-realmId-password-profiles-profileId 2 params body → 200400404422500
DELETE
/v2/authentication-realms/{realmId}/password-profiles/{profileId}
Delete Password Profile
delete-v2-authentication-realms-realmId-password-profiles-profileId 2 params → 204400404422500
POST
/v2/authentication-realms/{realmId}/password-profiles/{profileId}/one-time-password-token-request
Create One-Time Password Token Request
post-v2-authentication-realms-realmId-password-profiles-profileId-one-time-password-token-request 2 params body → 201202400404422500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PaginationLinks (6 properties), PasswordProfile (4 properties), OneTimePasswordTokenRequestInput (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

PasswordProfile
object
4 properties 2 required
MetaTimestamps
object
2 properties
OneTimePasswordTokenRequestResponse
OneTimePasswordTokenRequestInput
object
3 properties 3 required
PasswordProfileResponse
UUID
string
The unique identifier.
PaginationLinks
object
6 properties
Error
object
3 properties 2 required
SelfLink
object
1 property
PaginationMeta
object
2 properties
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-password-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