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 Account Members API

An `Account Member` resource is a user that you can add to accounts using account memberships.Account members API is read only, and you cannot add users using this API. There is a 1 to 1 correspondence between User Authentication Info and an Account Member, the corresponding objects have the same id. You must use the `user_authentication_info` object to create users in the authentication realm of account authentication settings. For more information on adding account members, see the [Adding Accounts and Account Members](/guides/How-To/Accounts/add-account-and-member) section.

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

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

3 operations 2 paths 8 schemas 2 GET1 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 Account Members 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.

Account Members 3

An Account Member resource is a user that you can add to accounts using account memberships. Account members API is read only, and you cannot add users using this API. There is a…

GET
/v2/account-members
Get all Account Members
get-v2-account-members 4 params → 200400401500
GET
/v2/account-members/{accountMemberID}
Get an Account Member
get-v2-account-members-accountMemberID 1 param → 200400404500
PUT
/v2/account-members/{accountMemberID}
Update an account member
put-v2-account-members-accountMemberID 1 param body → 200400404500

Schemas 8

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

MetaTimestamps
object
1 property
MetaList
object
2 properties
AccountMember
object
7 properties
MetaListResults
object
1 property
Error
object
3 properties 2 required
AccountMemberResponse
MetaListPage
object
4 properties
ErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-account-members-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 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
Elastic Path Authentication Realms API