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 Custom API Role Policies API

A Custom API Role Policy defines the level of access a role has to a Custom API. By default, administrative roles like **Store Admin** or **Org Admin** have full access to all Custom APIs. To grant access to other roles, a policy must be created for that specific role and Custom API.Below are the permissions that can be assigned to a role:| Permission | Description ||------------|------------------------------------------|| **Create** | Create a Custom API Entry. || **List** | Retrieve a list of Custom API Entries. || **Read** | Get a Custom API Entry. || **Update** | Update a Custom API Entry. || **Delete** | Delete a Custom API Entry. |

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

This API exposes 5 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.

5 operations 2 paths 8 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 Custom API Role Policies 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.

Custom API Role Policies 5

A Custom API Role Policy defines the level of access a role has to a Custom API. By default, administrative roles like Store Admin or Org Admin have full access to all Custom APIs…

POST
/v2/permissions/custom-api-role-policies
Create A Custom API Role Policy
CreateACustomAPIRolePolicy body → 201400409500
GET
/v2/permissions/custom-api-role-policies
List Custom API Role Policies
ListCustomAPIRolePolicies 4 params → 200400500
GET
/v2/permissions/custom-api-role-policies/{custom-api-role-policy-id}
Get a Custom API Role Policy
GetACustomAPIRolePolicy 1 param → 200404500
PUT
/v2/permissions/custom-api-role-policies/{custom-api-role-policy-id}
Update a Custom API Role Policy
UpdateACustomAPIRolePolicy 1 param body → 200400404500
DELETE
/v2/permissions/custom-api-role-policies/{custom-api-role-policy-id}
Delete a Custom API Role Policy
DeleteACustomAPIRolePolicy 1 param → 204400404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomAPIRolePolicy (10 properties), PaginationLinks (5 properties), Timestamps (2 properties), CustomAPIRolePolicyRelationships (2 properties). Each schema is shown below with its type and property counts.

Timestamps
object
2 properties
Meta
object
1 property
CustomAPIRolePolicyRelationships
object
2 properties
Errors
object
1 property 1 required
CustomAPIRolePolicy
object
10 properties
LinkURI
stringnull
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-custom-api-role-policies-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