The Zuplo Developer API, powered by Zuplo

API Keys - Consumers

Endpoint:https://dev.zuplo.com

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.

Lists consumers

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Lists all consumers belonging to this account.

Lists consumers › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.

Lists consumers › query Parameters

limitinteger · min: 1 · max: 1000 · required
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offsetinteger · min: 0 · required
The offset of the first item returned in the collection. Default: 0
include-api-keysboolean
Include the api key data in the response.
include-manager-invitesboolean
Include the manager invites data in the response.
include-managersboolean
Include the manager's data in the response.
key-formatstring · enum
The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.
Enum values:
none
visible
masked
manager-emailstring
Filter by email address of key manager.
tagstring
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

Lists consumers › Responses

The request has succeeded.

dataobject[] · required

limitinteger · uint32
Example: 1000
offsetinteger · uint32
Example: 0
totalinteger · uint32

Creates a consumer

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Creates a new consumer for this account.

Creates a consumer › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.

Creates a consumer › query Parameters

with-api-keyboolean
If an API key should be created with the consumer.

Creates a consumer › Request Body

namestring · pattern: ^[a-z0-9-]{1,128}$ · required
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

managers
Email addresses of the managers to invite or a list of managers (with subs) to add to the consumer.
apiKeysobject[]
descriptionstring
A description of the consumer.
tagsobject
Key value pairs to associate with the consumer.
metadataobject
Generic metadata associated with the consumer.

Creates a consumer › Responses

The request has succeeded.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
namestring · pattern: ^[a-z0-9-]{1,128}$ · required
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

apiKeysobject[]
descriptionstring
A description of the consumer.
tagsobject
Key value pairs to associate with the consumer.
metadataobject
Generic metadata associated with the consumer.

Gets a consumer

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Gets a consumer given a bucket name and consumer name.

Gets a consumer › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Gets a consumer › query Parameters

include-api-keysboolean
Include the api key data in the response.
key-formatstring · enum
The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.
Enum values:
none
visible
masked
include-managersboolean
Include the manager's data in the response.
include-manager-invitesboolean
Include the manager invites data in the response.
tagstring
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

Gets a consumer › Responses

The request has succeeded.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
namestring · pattern: ^[a-z0-9-]{1,128}$ · required
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

apiKeysobject[]
descriptionstring
A description of the consumer.
tagsobject
Key value pairs to associate with the consumer.
metadataobject
Generic metadata associated with the consumer.

Deletes a consumer

DELETE

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Deletes a consumer and any related resources

Deletes a consumer › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Deletes a consumer › query Parameters

tagstring
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

Deletes a consumer › Responses

There is no content to send for this request, but the headers may be useful.

No data returned

Updates a consumer

PATCH

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Update the consumer with the matching consumer name.

Updates a consumer › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Updates a consumer › query Parameters

tagstring
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

Updates a consumer › Request Body

descriptionstring
A description of the consumer.
tagsobject
Key value pairs to associate with the consumer.
metadataobject
Generic metadata associated with the consumer.

Updates a consumer › Responses

The request has succeeded.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
namestring · pattern: ^[a-z0-9-]{1,128}$ · required
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

apiKeysobject[]
descriptionstring
A description of the consumer.
tagsobject
Key value pairs to associate with the consumer.
metadataobject
Generic metadata associated with the consumer.

Roll consumer keys

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/roll-key

Set expiration for keys with no expiration date and creates a new key.

Roll consumer keys › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Roll consumer keys › query Parameters

tagstring
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

Roll consumer keys › Request Body

expiresOnstring · date-time · required
When the item will expire.
Example: 2050-04-18T05:54:34.408Z

Roll consumer keys › Responses

There is no content to send for this request, but the headers may be useful.

No data returned

API Keys - Keys API Keys - Buckets