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

Red Hat 3scale Authorization API

Authorize API calls and check access permissions

Red Hat 3scale Authorization API is one of 15 APIs that Red Hat 3scale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, https://{domain}-admin.3scale.net/admin/api.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://su1.3scale.net
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat 3scale Authorization API declares 1 security scheme for authenticating requests. An API key is passed in the query as access_token (provider_key). By default, every request must be authenticated.

Paths & Operations 2

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

Authorization 2

Authorize API calls and check access permissions

GET
/transactions/authorize.xml
Authorize API Transaction
authorizeTransaction 4 params → 200403404
GET
/transactions/authrep.xml
Authorize and Report API Transaction
authorizeAndReport 4 params → 200403

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UsageReport (6 properties), AuthorizeResponse (3 properties), AuthorizeErrorResponse (3 properties). Each schema is shown below with its type and property counts.

UsageReport
object
6 properties
AuthorizeErrorResponse
object
3 properties
AuthorizeResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-3scale-authorization-api-openapi.yml Raw ↑

Other APIs Red Hat 3scale publishes across the network.

Red Hat 3scale Webhooks
Red Hat 3scale Toolbox CLI
Red Hat 3scale Accounts API
Red Hat 3scale Applications API
Red Hat 3scale Configuration API
Red Hat 3scale DNS API
Red Hat 3scale Health API
Red Hat 3scale Initialization API
Red Hat 3scale Invoices API
Red Hat 3scale OAuth API
Red Hat 3scale Payment Transactions API
Red Hat 3scale Plans API