A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can learn more about consumers [here](https://zuplo.com/docs/articles/api-key-management#consumers).
Zuplo API Keys - Consumers API is one of 13 APIs that Zuplo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include API Keys - Consumers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and 4 JSON Schemas.
This API exposes
6 operations
across 3 paths,
and defines 12 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://dev.zuplo.com.
6 operations3 paths12 schemas1 DELETE2 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Zuplo API Keys - Consumers API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth — API key authentication. Format: Bearer {api-key}
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
API Keys - Consumers 6
A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can…
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Zuplo.ApiKeys.Consumer (8 properties), Zuplo.ApiKeys.ConsumerCreateBody (6 properties), Zuplo.ApiKeys.ApiKey (6 properties), Zuplo.ApiKeys.Consumers (4 properties). Each schema is shown below with its type and property counts.
A Consumer can have any number of API keys associated with it. Each API Key shares the same identity (i.e. Consumer) when authenticating with this service. Key…
Managers are users that have access to a consumer. Managers can be added directly to a consumer (using email and sub) or invited (using only email) to a consum…
2 properties4 required
Zuplo.ApiKeys.Consumer
object
Consumers are the core of the API Key service. The consumer is the 'identity' of any API Keys that are created.