capabilities.work

Onboard a Consumer With an API Key

A 3-step recipe with Zuplo. We can help you get access.

Recipe · 3 steps

Onboard a Consumer With an API Key

with Zuplo · Developer Identity & Credential Management

Provision a bucket, create a consumer with a key, then list its keys.

  1. Create the API key bucket that will hold the consumer.
  2. Create a consumer in the bucket and request that an API key be generated at the same time via the with-api-key query parameter.
  3. List the API keys for the new consumer to confirm a key was issued during consumer creation.
What you'll need to have ready
  • accountName: The Zuplo account name (Settings > Project Information).
  • apiKey: The Zuplo Developer API key, sent as a Bearer token.
  • bucketName: A friendly name for the bucket, matching ^[a-z0-9-]{5,128}$.
  • consumerName: A friendly name for the consumer, matching ^[a-z0-9-]{1,128}$.
  • consumerDescription: An optional description of the consumer.
For your developer

Arazzo workflow zuplo:onboard-consumer-with-key, 3 operations: ApiKeyBucketsService_create → ApiKeyConsumersService_create → ApiKeyKeysService_list. Specs on APIs.io.

More recipes with Zuplo

Add a Manager to a ConsumerBulk-Issue API Keys to a ConsumerCreate a Consumer and Issue an API KeyDeactivate a Consumer's API KeyDiscover Account and List Its BucketsFind and Update an API Key BucketFind a Consumer and Update Its MetadataFind and Delete a ConsumerMap a Custom Domain to a DeploymentProvision an API Key Bucket