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 users API is one of 42 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

5 operations 2 paths 7 schemas 1 DELETE2 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 users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.

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.

users 5

Users

GET
/iam/users
listUsers
listUsers 5 params → default200400401403429500502
POST
/iam/users
createUser
createUser 2 params → default201400401403409412429
DELETE
/iam/users/{id}
destroyUser
destroyUser 1 param → default204401403404429500502
GET
/iam/users/{id}
showUser
showUser 1 param → default200401403404429500502
PUT
/iam/users/{id}
replaceUser
replaceUser 3 params → default200400401403404412429

Schemas 7

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

GetUsersResponse
object
Gets all users
2 properties
PaginatedResponse
object
Contains default fields for paginatable APIs.
3 properties 3 required
Problem
object
9 properties
User
object
12 properties
PostUsersRequest
object
7 properties 1 required
RoleItem
object
Needed for granting permissions per group not individually.
4 properties 2 required
PutUsersByIdRequest
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newstore-users-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