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

Newstore roles API is one of 42 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include roles. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://dodici-demo.p.newstore.net.

7 operations 4 paths 11 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://dodici-demo.p.newstore.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Newstore roles API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.

Paths & Operations 7

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

roles 7

Roles

GET
/iam/permissions
listPermissions
listPermissions → default200401403429500502503
GET
/iam/roles
listRoles
listRoles 1 param → default200400401403429500502
POST
/iam/roles
createRole
createRole 2 params → default201400401403409412429
DELETE
/iam/roles/{id}
destroyRole
destroyRole 1 param → default204401403404423429500
GET
/iam/roles/{id}
showRole
showRole 1 param → default200401403404429500502
PUT
/iam/roles/{id}
replaceRole
replaceRole 3 params → default200400401403404412423
GET
/iam/roles/{id}/users
listUsersByRole
listUsersByRole 3 params → default200400401403404429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are User (12 properties), Problem (9 properties), Role (6 properties), RoleItem (4 properties). Each schema is shown below with its type and property counts.

GetPermissionsResponse
object
Returns a list of available permissions the system provides.
1 property
Problem
object
9 properties
Application
string
Abbreviation of the application this permission belongs to.
Permission
object
List of all available system permissions.
3 properties 2 required
User
object
12 properties
PostRolesRequest
object
Needed for granting permissions per group not individually.
2 properties 2 required
PutRolesByIdRequest
object
Needed for granting permissions per group not individually.
2 properties 2 required
Role
object
Needed for granting permissions per group not individually.
6 properties 2 required
GetUsersByRoleResponse
object
Gets all users by role
1 property
RoleItem
object
Needed for granting permissions per group not individually.
4 properties 2 required
GetRolesResponse
object
Returns a list of roles.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newstore-roles-api-openapi.yml Raw ↑

Other APIs Newstore publishes across the network.

Newstore address API
Newstore audit-events API
Newstore cart API
Newstore cashboxes API
Newstore customer-configuration API
Newstore customer-profile API
Newstore customerProfile API
Newstore data API
Newstore EasypostAdapterConfig API
Newstore external-public API
Newstore fulfillment-requests API
Newstore identity-providers API