API Keys - Consumers
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://dev.zuplo.com
Lists consumers
Lists all consumers belonging to this account.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
query Parameters
limit
integer · min: 1 · max: 1000 · requiredThe maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offset
integer · requiredThe offset of the first item returned in the collection. Default: 0
include-api-keys
booleanInclude the api key data in the response.
include-manager-invites
booleanInclude the manager invites data in the response.
include-managers
booleanInclude the manager's data in the response.
key-format
string · enumThe 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:nonevisiblemaskedmanager-email
stringFilter by email address of key manager.
tag
stringQuery by tag. Example usage is
tag.account=foo
, whereaccount
is the name of the tag property andfoo
is the value.
Responses
data
object[] · requiredlimit
integer · uint32offset
integer · uint32total
integer · uint32
Creates a consumer
Creates a new consumer for this account.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
query Parameters
with-api-key
booleanIf an API key should be created with the consumer.
Request Body
name
string · pattern:^[a-z0-9-]{1,128}$
· requiredA 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.
apiKeys
object[]description
stringA description of the consumer.
tags
objectKey value pairs to associate with the consumer.
metadata
objectGeneric metadata associated with the consumer.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{1,128}$
· requiredA friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.
apiKeys
object[]description
stringA description of the consumer.
tags
objectKey value pairs to associate with the consumer.
metadata
objectGeneric metadata associated with the consumer.
Gets a consumer
Gets a consumer given a bucket name and consumer name.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
string · requiredThe name of the consumer.
query Parameters
include-api-keys
booleanInclude the api key data in the response.
key-format
string · enumThe 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:nonevisiblemaskedinclude-managers
booleanInclude the manager's data in the response.
include-manager-invites
booleanInclude the manager invites data in the response.
tag
stringQuery by tag. Example usage is
tag.account=foo
, whereaccount
is the name of the tag property andfoo
is the value.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{1,128}$
· requiredA friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.
apiKeys
object[]description
stringA description of the consumer.
tags
objectKey value pairs to associate with the consumer.
metadata
objectGeneric metadata associated with the consumer.
Deletes a consumer
Deletes a consumer and any related resources
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
string · requiredThe name of the consumer.
query Parameters
tag
stringQuery by tag. Example usage is
tag.account=foo
, whereaccount
is the name of the tag property andfoo
is the value.
Responses
Updates a consumer
Update the consumer with the matching consumer name.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
string · requiredThe name of the consumer.
query Parameters
tag
stringQuery by tag. Example usage is
tag.account=foo
, whereaccount
is the name of the tag property andfoo
is the value.
Request Body
description
stringA description of the consumer.
tags
objectKey value pairs to associate with the consumer.
metadata
objectGeneric metadata associated with the consumer.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{1,128}$
· requiredA friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.
apiKeys
object[]description
stringA description of the consumer.
tags
objectKey value pairs to associate with the consumer.
metadata
objectGeneric metadata associated with the consumer.
Roll consumer keys
Set expiration for keys with no expiration date and creates a new key.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
string · requiredThe name of the consumer.
query Parameters
tag
stringQuery by tag. Example usage is
tag.account=foo
, whereaccount
is the name of the tag property andfoo
is the value.
Request Body
expiresOn
string · date-time · requiredWhen the item will expire.