{
  "opencollection": "1.0.0",
  "info": {
    "name": "Zuplo Developer API Keys - Buckets API Keys - Consumers API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "API Keys - Consumers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists Consumers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first item returned in the collection. Default: 0"
              },
              {
                "name": "include-api-keys",
                "value": "",
                "type": "query",
                "description": "Include the api key data in the response."
              },
              {
                "name": "include-manager-invites",
                "value": "",
                "type": "query",
                "description": "Include the manager invites data in the response."
              },
              {
                "name": "include-managers",
                "value": "",
                "type": "query",
                "description": "Include the manager's data in the response."
              },
              {
                "name": "key-format",
                "value": "",
                "type": "query",
                "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible."
              },
              {
                "name": "manager-email",
                "value": "",
                "type": "query",
                "description": "Filter by email address of key manager."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value."
              }
            ]
          },
          "docs": "Lists all consumers belonging to this account."
        },
        {
          "info": {
            "name": "Creates a Consumer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "with-api-key",
                "value": "",
                "type": "query",
                "description": "If an API key should be created with the consumer."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new consumer for this account."
        },
        {
          "info": {
            "name": "Gets a Consumer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "consumerName",
                "value": "",
                "type": "path",
                "description": "The name of the consumer."
              },
              {
                "name": "include-api-keys",
                "value": "",
                "type": "query",
                "description": "Include the api key data in the response."
              },
              {
                "name": "key-format",
                "value": "",
                "type": "query",
                "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible."
              },
              {
                "name": "include-managers",
                "value": "",
                "type": "query",
                "description": "Include the manager's data in the response."
              },
              {
                "name": "include-manager-invites",
                "value": "",
                "type": "query",
                "description": "Include the manager invites data in the response."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value."
              }
            ]
          },
          "docs": "Gets a consumer given a bucket name and consumer name."
        },
        {
          "info": {
            "name": "Updates a Consumer",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "consumerName",
                "value": "",
                "type": "path",
                "description": "The name of the consumer."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the consumer with the matching consumer name."
        },
        {
          "info": {
            "name": "Deletes a Consumer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "consumerName",
                "value": "",
                "type": "path",
                "description": "The name of the consumer."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value."
              }
            ]
          },
          "docs": "Deletes a consumer and any related resources"
        },
        {
          "info": {
            "name": "Roll Consumer Keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key",
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "The name of the account. You can find this in your Zuplo Portal under Settings > Project Information."
              },
              {
                "name": "bucketName",
                "value": "",
                "type": "path",
                "description": "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."
              },
              {
                "name": "consumerName",
                "value": "",
                "type": "path",
                "description": "The name of the consumer."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set expiration for keys with no expiration date and creates a new key."
        }
      ]
    }
  ],
  "bundled": true
}