Zuplo
The Zuplo Developer API, powered by Zuplo

​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.

Endpoint:https://developer-api-main-8600723.self.zuplo.com

​Lists consumers

GET
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Lists all consumers belonging to this account.

​Lists consumers › path Parameters

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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

  • limit
    integer · 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

  • offset
    integer · required

    The offset of the first item returned in the collection. Default: 0

  • include-api-keys
    boolean

    Include the api key data in the response.

  • include-manager-invites
    boolean

    Include the manager invites data in the response.

  • include-managers
    boolean

    Include the manager's data in the response.

  • key-format
    string · 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-email
    string

    Filter by email address of key manager.

  • tag
    string

    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

    • data
      object[] · required
    • limit
      integer · uint32
    • offset
      integer · uint32
    • total
      integer · uint32

​Creates a consumer

POST
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Creates a new consumer for this account.

​Creates a consumer › path Parameters

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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-key
    boolean

    If an API key should be created with the consumer.

​Creates a consumer › Request Body

  • name
    string · 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.

  • apiKeys
    object[]
  • description
    string

    A description of the consumer.

  • tags
    object

    Key value pairs to associate with the consumer.

  • metadata
    object

    Generic metadata associated with the consumer.

​Creates a consumer › Responses

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • name
      string · 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.

    • apiKeys
      object[]
    • description
      string

      A description of the consumer.

    • tags
      object

      Key value pairs to associate with the consumer.

    • metadata
      object

      Generic metadata associated with the consumer.

​Gets a consumer

GET
https://developer-api-main-8600723.self.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

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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.

  • consumerName
    string · required

    The name of the consumer.

​Gets a consumer › query Parameters

  • include-api-keys
    boolean

    Include the api key data in the response.

  • key-format
    string · 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-managers
    boolean

    Include the manager's data in the response.

  • include-manager-invites
    boolean

    Include the manager invites data in the response.

  • tag
    string

    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

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • name
      string · 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.

    • apiKeys
      object[]
    • description
      string

      A description of the consumer.

    • tags
      object

      Key value pairs to associate with the consumer.

    • metadata
      object

      Generic metadata associated with the consumer.

​Deletes a consumer

DELETE
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Deletes a consumer and any related resources

​Deletes a consumer › path Parameters

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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.

  • consumerName
    string · required

    The name of the consumer.

​Deletes a consumer › query Parameters

  • tag
    string

    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

    No response specified

​Updates a consumer

PATCH
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Update the consumer with the matching consumer name.

​Updates a consumer › path Parameters

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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.

  • consumerName
    string · required

    The name of the consumer.

​Updates a consumer › query Parameters

  • tag
    string

    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

  • description
    string

    A description of the consumer.

  • tags
    object

    Key value pairs to associate with the consumer.

  • metadata
    object

    Generic metadata associated with the consumer.

​Updates a consumer › Responses

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • name
      string · 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.

    • apiKeys
      object[]
    • description
      string

      A description of the consumer.

    • tags
      object

      Key value pairs to associate with the consumer.

    • metadata
      object

      Generic metadata associated with the consumer.

​Roll consumer keys

POST
https://developer-api-main-8600723.self.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

  • accountName
    string · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string · 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.

  • consumerName
    string · required

    The name of the consumer.

​Roll consumer keys › query Parameters

  • tag
    string

    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

  • expiresOn
    string · date-time · required

    When the item will expire.

​Roll consumer keys › Responses

    No response specified