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

NCR Security API

Authentication, authorization, and user password management.

NCR Security API is one of 7 APIs that NCR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and code examples.

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

Requests are made against 2 base URLs: https://api.ncr.com, https://gateway-staging.ncrcloud.com.

4 operations 4 paths 3 schemas 1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ncr.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NCR Security API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmacAccessKey). By default, every request must be authenticated.

  • hmacAccessKey — AccessKey (HMAC) authentication. The Authorization header carries "AccessKey {sharedKey}:{signature}", where the signature is a Base64 SHA-512 HMAC computed ov…

Paths & Operations 4

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

Security 4

Authentication, authorization, and user password management.

POST
/security/authentication/login
NCR Voyix Authenticate User
authenticateUser 1 param body → 200401
POST
/security/authorization
NCR Voyix Exchange Authorization Token
exchangeToken 1 param body → 200
PUT
/security/security-user-passwords/{username}
NCR Voyix Set User Password
setUserPassword 1 param body → 204
GET
/security/role-grants/user-grants/self/effective-roles
NCR Voyix Get Self Effective Roles
getSelfEffectiveRoles → 200

Schemas 3

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

LoginRequest
object
2 properties 2 required
TokenResponse
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncr-security-api-openapi.yml Raw ↑

Other APIs NCR publishes across the network.

NCR Catalog API
NCR Category API
NCR Order API
NCR Provisioning API
NCR Selling API
NCR Site API