{
  "opencollection": "1.0.0",
  "info": {
    "name": "FlashArray REST Active Directory Object Store Access Keys API",
    "version": "2.52"
  },
  "items": [
    {
      "info": {
        "name": "Object Store Access Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Pure Storage GET Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n"
              },
              {
                "name": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "List object store access keys."
        },
        {
          "info": {
            "name": "Pure Storage POST Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.52/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The generation of object store access keys. This process produces a new `access key ID` and\n`secret key` for the specified user.\n"
        },
        {
          "info": {
            "name": "Pure Storage PATCH Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.52/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enable or disable object store access keys."
        },
        {
          "info": {
            "name": "Pure Storage DELETE Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.52/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\n"
              }
            ]
          },
          "docs": "Delete an object store access key. Once an access key has been deleted, it cannot be recovered."
        },
        {
          "info": {
            "name": "Pure Storage GET Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.26/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n"
              },
              {
                "name": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The offset of the first resource to return from a collection.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n"
              }
            ]
          },
          "docs": "List object store access keys."
        },
        {
          "info": {
            "name": "Pure Storage POST Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.26/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource names to import.\nTo import a set of credentials, this field must be specified\nwith the `secret_access_key` body parameter. If both of these\nare not specified, the system will generate a new set of credentials.\n\nA matching realm prefix is required when importing credentials for\na user in a realm. For example, use\n`realm1::PSFBSAZRBHOODCBADKNFKCBCPCNHLHMEJOIOHHBACEL` when importing\ncredentials for user `realmName::accountName/userName`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or import object store access keys. When importing an access key,\nthe access key id is provided by the `names` header parameter and the\nthe secret key must be also provided. When importing an access key for a\nuser in a realm, the value of `names` must be prefixed with the realm of the\nuser.\n"
        },
        {
          "info": {
            "name": "Pure Storage PATCH Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.26/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource names.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enable or disable object store access keys."
        },
        {
          "info": {
            "name": "Pure Storage DELETE Object-store-access-keys",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.26/object-store-access-keys",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource names.\n"
              }
            ]
          },
          "docs": "Delete an object store access key. Once an access key has been deleted, it cannot be recovered."
        }
      ]
    }
  ],
  "bundled": true
}