{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory User Group Quotas API", "version": "2.52" }, "items": [ { "info": { "name": "User Group Quotas", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Group Quotas.", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-group-quotas", "headers": [ { "name": "Authorization", "value": "" }, { "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": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nFor example, `fs:dir01,fs:dir02`.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "group_ids", "value": "", "type": "query", "description": "Performs the operation on the groups that match the given list of gids.\nEnter names in a comma-separated format, e.g., `2001,2002`.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "Performs the operation on the unique group name specified.\nExamples of groups include host groups, pods, protection groups, and volume groups.\nEnter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.\n\n" }, { "name": "group_sids", "value": "", "type": "query", "description": "Performs the operation on the specified group SID.\nEnter multiple group SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "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": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nFor example, `name01,name02`.\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": "Displays a list of groups and the group quota rules that affect their usage limits.\n" }, { "info": { "name": "Pure Storage List User Quotas.", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-user-quotas", "headers": [ { "name": "Authorization", "value": "" }, { "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": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nFor example, `fs:dir01,fs:dir02`.\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": "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": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nFor example, `name01,name02`.\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" }, { "name": "user_ids", "value": "", "type": "query", "description": "Performs the operation on the users that match the given list of uids.\nEnter names in a comma-separated format, for example, `1001,1002`.\n" }, { "name": "user_names", "value": "", "type": "query", "description": "Performs the operation on the users that match the given list of user names.\nEnter names in a comma-separated format, for example, `u1,u2`.\n" }, { "name": "user_sids", "value": "", "type": "query", "description": "Performs the operation on the users that match the given list of user SIDs.\nEnter SIDs in a comma-separated format, for example, `S-1-1-20-1000,S-1-1-20-2002`.\n" } ] }, "docs": "Displays a list of users and the user quota rules that affect their usage limits.\n" }, { "info": { "name": "Pure Storage GET /File-system-group-quotas", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/file-system-group-quotas", "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": "file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of file system IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `file_system_ids`, then an error is returned.\nThis cannot be provided together with the `file_system_names` query parameter.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "A comma-separated list of file system names.\nIf there is not at least one resource that matches\neach of the elements of `file_system_names`, then an error is returned.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "gids", "value": "", "type": "query", "description": "Performs the operation on the specified GIDs.\nEnter multiple GIDs in comma-separated format.\nFor example, `4234235,9681923`.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "A comma-separated list of group names.\nIf there is not at least one resource that matches\neach of the elements of `group_names`, then an error is returned.\nThis cannot be provided together with `gids` query parameter.\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": "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": "Lists groups with their respective usage and all the quota rules applicable to them." }, { "info": { "name": "Pure Storage GET /File-system-user-quotas", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/file-system-user-quotas", "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": "file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of file system IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `file_system_ids`, then an error is returned.\nThis cannot be provided together with the `file_system_names` query parameter.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "A comma-separated list of file system names.\nIf there is not at least one resource that matches\neach of the elements of `file_system_names`, then an error is returned.\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": "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" }, { "name": "uids", "value": "", "type": "query", "description": "A comma-separated list of user IDs (UIDs).\nEnter multiple user IDs in comma-separated format.\nFor example, `423,51234`.\n" }, { "name": "user_names", "value": "", "type": "query", "description": "A comma-separated list of user names.\nIf there is not at least one resource that matches\neach of the elements of `user_names`, then an error is returned.\nThis cannot be provided together with `uids` query parameter.\n" }, { "name": "user_sids", "value": "", "type": "query", "description": "A comma-separated list of WINDOWS user SIDs.\nIf there is not at least one resource that matches\neach of the elements of `user_sids`, then an error is returned.\nThis cannot be provided together with `uids` or `user_names` query parameters.\n" } ] }, "docs": "Lists users with their respective usage and all the quota rules applicable to them." } ] } ], "bundled": true }