{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Policies (All) API", "version": "2.52" }, "items": [ { "info": { "name": "Policies (All)", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Policies-all", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/policies-all", "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": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\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 all policies of all types." }, { "info": { "name": "Pure Storage GET Policies-all/members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/policies-all/members", "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": "local_file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of local file system IDs. If after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`local_file_system_names` query parameter.\n" }, { "name": "local_file_system_names", "value": "", "type": "query", "description": "A comma-separated list of local file system names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `local_file_system_ids`\nquery parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "A comma-separated list of member types. Valid values include `file-systems`,\n`file-system-snapshots`, `file-system-replica-links`, `object-store-users`,\nand `object-store-accounts`. Different endpoints may accept different subsets\nof these values.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" }, { "name": "remote_file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of remote file system IDs. If there is not at\nleast one resource that matches each of the elements, then an error is\nreturned. This cannot be provided together with the `remote_file_system_names`\nquery parameter.\n" }, { "name": "remote_file_system_names", "value": "", "type": "query", "description": "A comma-separated list of remote file system names. If there is not at\nleast one resource that matches each of the elements, then an error is\nreturned. This cannot be provided together with the `remote_file_system_ids`\nquery parameter.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "A comma-separated list of remote array IDs. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_names` query parameter.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "A comma-separated list of remote array names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_ids` query parameter.\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 policies (of all types) mapped to other entities (file systems,\nsnapshots, file system replica links, and object store users).\nNote: if more than 150,000 items would be returned in the response, an error will be thrown\nand query parameters must be used to limit the items queried.\n" } ] } ], "bundled": true }