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 User Authentication Infos API

A `user-authentication-info` represents a user. This object contains information, such as the name and email address, and has sub-resources for each mechanism that the user can use to log in./single-sign-on/authentication-realm-api/authentication-realm-api-overview) and the user is configured to authenticate through that profile, then the `user-authentication-info` object is associated with a [User Authentication OpenID Connect Profile Info](/docs/api/single-sign-on/user-authentication-oidc-profile-infos) subresource.[Account Members](/docs/api/accounts/get-v-2-account-members-account-member-id) reference User Authentication Infos directly (i.e., for every account member there is an user authentication info with the same id) and the User Authentication Info API is how you manage and configure the authentication options for that user.[Customers (that login via OIDC)](/docs/customer-management/customer-management-api/get-a-customer) also use the User Authentication Info.

Elastic Path User Authentication Infos 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 User Authentication Infos. 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 User Authentication Infos 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.

User Authentication Infos 5

A user-authentication-info represents a user. This object contains information, such as the name and email address, and has sub-resources for each mechanism that the user can use…

GET
/v2/authentication-realms/{realmId}/user-authentication-info
Get User Authentication Info List
get-v2-authentication-realms-realmId-user-authentication-info 5 params → 200400404422500
POST
/v2/authentication-realms/{realmId}/user-authentication-info
Create User Authentication Info
post-v2-authentication-realms-realmId-user-authentication-info 1 param body → 201400404422500
GET
/v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}
Get User Authentication Info
get-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId 2 params → 200400404422500
PUT
/v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}
Update User Authentication Info
put-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId 2 params body → 200400404422500
DELETE
/v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}
Delete User Authentication Info
delete-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId 2 params → 204404422500

Schemas 9

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

UUID
string
The unique identifier.
MetaList
object
2 properties
UserAuthenticationInfo
object
6 properties 3 required
UserAuthenticationInfoResponse
MetaListResults
object
1 property
Error
object
3 properties 2 required
SelfLink
object
1 property
MetaListPage
object
4 properties
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-user-authentication-infos-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