{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Certificate Groups API", "version": "2.52" }, "items": [ { "info": { "name": "Certificate Groups", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Certificate-groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/certificate-groups", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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": "Display all array certificate groups.\n" }, { "info": { "name": "Pure Storage Create Certificate-groups", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/certificate-groups", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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" } ] }, "docs": "Creates one or more certificate groups on the array.\n" }, { "info": { "name": "Pure Storage Delete Certificate-groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/certificate-groups", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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" } ] }, "docs": "Deletes one or more certificate groups from the array.\n" }, { "info": { "name": "Pure Storage List Certificate-groups and Certificates", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/certificate-groups/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\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": "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": "Lists membership associations between groups and certificates on the array.\n" }, { "info": { "name": "Pure Storage Create Certificate-groups/certificates", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/certificate-groups/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\n" } ] }, "docs": "Creates one or more certificates to one or more certificate groups on the array.\n" }, { "info": { "name": "Pure Storage Delete Certificate-groups or Certificates", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/certificate-groups/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\n" } ] }, "docs": "Deletes one or more certificate groups.\n" }, { "info": { "name": "Pure Storage List Certificate-groups/uses", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/certificate-groups/uses", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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": "Lists how certificate groups are being used and by what.\n" }, { "info": { "name": "Pure Storage GET Certificate-groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/certificate-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Display all array certificate groups." }, { "info": { "name": "Pure Storage POST Certificate-groups", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/certificate-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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" } ] }, "docs": "Create one or more certificate groups on the array." }, { "info": { "name": "Pure Storage DELETE Certificate-groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/certificate-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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" } ] }, "docs": "Delete one or more certificate groups from the array." }, { "info": { "name": "Pure Storage GET Certificate-groups/certificates", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/certificate-groups/certificates", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "A comma-separated list of certificate names.\nIf there is not at least one resource that matches each of the\nelements of `certificate_names`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_ids`\nparameter.\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": "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 membership associations between groups and certificates on the array." }, { "info": { "name": "Pure Storage POST Certificate-groups/certificates", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/certificate-groups/certificates", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "A comma-separated list of certificate names.\nIf there is not at least one resource that matches each of the\nelements of `certificate_names`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_ids`\nparameter.\n" } ] }, "docs": "Add one or more certificates to one or more certificate groups on the array." }, { "info": { "name": "Pure Storage DELETE Certificate-groups/certificates", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/certificate-groups/certificates", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_group_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate group ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_names` parameter.\n" }, { "name": "certificate_group_names", "value": "", "type": "query", "description": "A comma-separated list of certificate group names.\nIf no resource matches each of the elements of `certificate_group_names`,\nthen an error is returned.\nThis cannot be provided in conjunction with the `certificate_group_ids` parameter.\n" }, { "name": "certificate_ids", "value": "", "type": "query", "description": "A comma-separated list of certificate ids.\nIf there is not at least one resource that matches each of the\nelements of `certificate_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_names`\nparameter.\n" }, { "name": "certificate_names", "value": "", "type": "query", "description": "A comma-separated list of certificate names.\nIf there is not at least one resource that matches each of the\nelements of `certificate_names`, then an error is returned.\nThis cannot be provided in conjunction with the `certificate_ids`\nparameter.\n" } ] }, "docs": "Delete one or more certificate groups." }, { "info": { "name": "Pure Storage GET Certificate-groups/uses", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/certificate-groups/uses", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 how certificate groups are being used and by what." } ] } ], "bundled": true }