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.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.