{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Directory Services API", "version": "2.52" }, "items": [ { "info": { "name": "Directory Services", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Directory Services Configuration", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services", "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": "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\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": "Displays the directory services configuration settings for manageability.\n" }, { "info": { "name": "Pure Storage Create Directory Services Configuration", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services", "headers": [ { "name": "Authorization", "value": "" }, { "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.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates directory services configuration.\nAll directory services configuration created using this resource will have `services`\nset to `data`.\n" }, { "info": { "name": "Pure Storage Modify Directory Services Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services", "headers": [ { "name": "Authorization", "value": "" }, { "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": "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" }, { "name": "to_member_ids", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple IDs in a comma-separated format.\n" }, { "name": "to_member_names", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple names in a comma-separated format.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the directory service configuration.\n" }, { "info": { "name": "Pure Storage Delete Directory Services Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services", "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" } ] }, "docs": "Deletes directory services configuration.\nDirectory service configuration must not be referenced by any server nor enabled to be deleted.\nThe built-in \"management\" directory service cannot be deleted.\n\n" }, { "info": { "name": "Pure Storage List Group to Management Access Policy Mappings", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/roles", "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": "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.\nFor example, `GroupRoleMappingName`.\nEnter multiple names in comma-separated format.\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": "role_names", "value": "", "type": "query", "description": "This field has been deprecated.\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 access control settings for remote groups.\n" }, { "info": { "name": "Pure Storage Create a Group in Management Access Policy Mappings", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/roles", "headers": [ { "name": "Authorization", "value": "" }, { "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 names specified.\nFor example, `GroupRoleMappingName`.\nEnter multiple names in comma-separated format.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more groups in management access policy mappings.\n" }, { "info": { "name": "Pure Storage Modify Group to Management Access Policy Mappings", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services/roles", "headers": [ { "name": "Authorization", "value": "" }, { "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 names specified.\nFor example, `GroupRoleMappingName`.\nEnter multiple names in comma-separated format.\n" }, { "name": "role_names", "value": "", "type": "query", "description": "This field has been deprecated.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies properties of one or more group to management access policy mappings.\nModifying management access policies is done at\n`/directory-services/roles/policies/management-access` instead.\n" }, { "info": { "name": "Pure Storage Delete Group to Management Access Policy Mappings", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/roles", "headers": [ { "name": "Authorization", "value": "" }, { "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 names specified.\nFor example, `GroupRoleMappingName`.\nEnter multiple names in comma-separated format.\n" } ] }, "docs": "Deletes one or more group to management access policy mappings.\n" }, { "info": { "name": "Pure Storage List Management Access Policies Attached to a Group to Management Access Policy Mapping", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/roles/policies/management-access", "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": "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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\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 management access policies that are attached to a group to management access\npolicy mappings.\n\n" }, { "info": { "name": "Pure Storage Create a Membership Between a Group to Management Access Policy Mapping with One or More Management Access Policies", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/roles/policies/management-access", "headers": [ { "name": "Authorization", "value": "" }, { "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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a membership between a group to management access policy mapping with one or more\nmanagement access policies. One of `member_ids` or `member_names` parameter is required.\n\n" }, { "info": { "name": "Pure Storage Delete a Membership Between a Group to Management Access Policy Mapping and One or More Management Access Policies", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/roles/policies/management-access", "headers": [ { "name": "Authorization", "value": "" }, { "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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\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" } ] }, "docs": "Deletes a membership between a group to management access policy mapping with one or more\nmanagement access policies. One of `policy_ids` or `policy_names` is required, and one of\n`member_ids` or `member_names` is required.\n\n" }, { "info": { "name": "Pure Storage GET Directory-service/test", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/test", "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": "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 name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\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": "server_names", "value": "", "type": "query", "description": "Server names providing the context for the operation.\nNames are expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `server01,server02`.\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": "The diagnostic utility that verifies the status and configuration of the `directory services` on the `array`." }, { "info": { "name": "Pure Storage PATCH Directory-service/test", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services/test", "headers": [ { "name": "Authorization", "value": "" }, { "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": "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 name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\n" }, { "name": "server_names", "value": "", "type": "query", "description": "Server names providing the context for the operation.\nNames are expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `server01,server02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The diagnostic utility that verifies the status of the configured `directory services` on the `array`. This process supports the optional provision of `configuration` modifications, allowing for validation of proposed changes in a test environment without affecting the current active settings." }, { "info": { "name": "Pure Storage List Local Directory Services", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/local/directory-services", "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\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": "Displays a list of local directory services.\n" }, { "info": { "name": "Pure Storage Create Local Directory Service", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/local/directory-services", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local directory service.\n" }, { "info": { "name": "Pure Storage Modify Local Directory Service", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services/local/directory-services", "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" }, { "name": "to_member_ids", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple IDs in a comma-separated format.\n" }, { "name": "to_member_names", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple names in a comma-separated format.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies local directory services.\n" }, { "info": { "name": "Pure Storage Delete Local Directory Services", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/local/directory-services", "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 name specified.\nEnter multiple names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `name01,pod01::name01`.\n" } ] }, "docs": "Deletes local directory services.\nLocal directory service can't be deleted when referenced\nby any server.\n" }, { "info": { "name": "Pure Storage List Local Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/local/groups", "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": "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": "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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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 local groups.\n" }, { "info": { "name": "Pure Storage Create Local Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/local/groups", "headers": [ { "name": "Authorization", "value": "" }, { "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "Creates a local group.\n" }, { "info": { "name": "Pure Storage Modify Local Groups", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services/local/groups", "headers": [ { "name": "Authorization", "value": "" }, { "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": "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies local groups.\nThe `gids`, `names`, or `sids` parameter is required, but cannot be set together.\n\n" }, { "info": { "name": "Pure Storage Delete Local Groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/local/groups", "headers": [ { "name": "Authorization", "value": "" }, { "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": "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ] }, "docs": "Deletes one or more local groups.\nThe `gids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage List Local Group Memberships", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/local/groups/members", "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": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "Performs the operation on the member types specified.\nThe type of member is the full name of the resource endpoint.\nValid values include `directories`.\nEnter multiple member types in comma-separated format.\nFor example, `type01,type02`.\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": "Displays a list of local group memberships.\n" }, { "info": { "name": "Pure Storage Create Local Group Membership", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/local/groups/members", "headers": [ { "name": "Authorization", "value": "" }, { "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local group membership with a group.\nThe `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set\ntogether.\n" }, { "info": { "name": "Pure Storage Delete Local Group Membership", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/local/groups/members", "headers": [ { "name": "Authorization", "value": "" }, { "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "Performs the operation on the member types specified.\nThe type of member is the full name of the resource endpoint.\nValid values include `directories`.\nEnter multiple member types in comma-separated format.\nFor example, `type01,type02`.\n" } ] }, "docs": "Deletes one or more local group memberships.\nThe `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set\ntogether.\nThe `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set\ntogether.\n\n" }, { "info": { "name": "Pure Storage List Local Users", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/local/users", "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": "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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "uids", "value": "", "type": "query", "description": "A comma-separated list of local user IDs (UIDs).\nEnter multiple local user IDs in comma-separated format.\nFor example, `423,51234`.\n" } ] }, "docs": "Displays a list of local users.\n" }, { "info": { "name": "Pure Storage Create Local User", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/local/users", "headers": [ { "name": "Authorization", "value": "" }, { "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "Creates a local user.\n" }, { "info": { "name": "Pure Storage Modify Local User", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-services/local/users", "headers": [ { "name": "Authorization", "value": "" }, { "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": "keep_open_sessions", "value": "", "type": "query", "description": "If set to `true`, the session does not expire.\nIf set to `false`, when the user is disabled or password is changed, the session expires.\nIf not specified, defaults to `false`.\n" }, { "name": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "uids", "value": "", "type": "query", "description": "A comma-separated list of local user IDs (UIDs).\nEnter multiple local user IDs in comma-separated format.\nFor example, `423,51234`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a local user.\n" }, { "info": { "name": "Pure Storage Delete Local Users", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/local/users", "headers": [ { "name": "Authorization", "value": "" }, { "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\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": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "uids", "value": "", "type": "query", "description": "A comma-separated list of local user IDs (UIDs).\nEnter multiple local user IDs in comma-separated format.\nFor example, `423,51234`.\n" } ] }, "docs": "Deletes one or more local users.\nThe `uids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage List Local User Memberships", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-services/local/users/members", "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": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "Displays a list of local user memberships.\n" }, { "info": { "name": "Pure Storage Create Local User Membership", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-services/local/users/members", "headers": [ { "name": "Authorization", "value": "" }, { "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local user membership with a group.\nThe `member_names` or `member_sids` or `member_ids` parameter is required,\nbut cannot be set together.\n" }, { "info": { "name": "Pure Storage Delete Local User Membership", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-services/local/users/members", "headers": [ { "name": "Authorization", "value": "" }, { "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "Performs the operation on the member types specified.\nThe type of member is the full name of the resource endpoint.\nValid values include `directories`.\nEnter multiple member types in comma-separated format.\nFor example, `type01,type02`.\n" } ] }, "docs": "Deletes one or more local user memberships.\nThe `member_names`, `member_sids`, or `member_ids` parameter is required, but cannot be set\ntogether.\n" }, { "info": { "name": "Pure Storage GET Directory-services", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services", "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 directory service configuration information." }, { "info": { "name": "Pure Storage PATCH Directory-services", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies and tests the directory service configuration.\n" }, { "info": { "name": "Pure Storage GET Directory-service/roles", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/roles", "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 `names`, `role_names`,\nor `role_ids` 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": "A comma-separated list of resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `names`, then an error is returned.\nThis cannot be provided together with the `ids`, `role_names`,\nor `role_ids` query parameters.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "role_ids", "value": "", "type": "query", "description": "A comma-separated list of role_ids.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `role_ids`, then an error is returned.\nThis cannot be provided together with the `ids`, `names` or\n`role_names` query parameters.\nThis query parameter is deprecated for use with directory service\nroles. If this parameter is used to query or modify directory\nservice roles, but more than 1 configuration exists with a given\nrole id, an error will be returned in order to avoid ambiguous\noperation.\n" }, { "name": "role_names", "value": "", "type": "query", "description": "A comma-separated list of role_names.\nIf there is not at least one resource that matches\neach of the elements of `role_names`, then an error is returned.\nThis cannot be provided together with the `ids`, `names`,\nor `role_ids` query parameters.\nThis query parameter is deprecated for use with directory service\nroles. If this parameter is used to query or modify directory\nservice roles, but more than 1 configuration exists with a given\nrole name, an error will be returned in order to avoid ambiguous\noperation.\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": "Return array's RBAC group configuration settings for manageability.\n" }, { "info": { "name": "Pure Storage POST Directory-service/roles", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/roles", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an RBAC group configuration setting for manageability.\n" }, { "info": { "name": "Pure Storage PATCH Directory-service/roles", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services/roles", "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 `names`, `role_names`,\nor `role_ids` query parameters.\n" }, { "name": "names", "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 `names`, then an error is returned.\nThis cannot be provided together with the `ids`, `role_names`,\nor `role_ids` query parameters.\n" }, { "name": "role_ids", "value": "", "type": "query", "description": "A comma-separated list of role_ids.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `role_ids`, then an error is returned.\nThis cannot be provided together with the `ids`, `names` or\n`role_names` query parameters.\nThis query parameter is deprecated for use with directory service\nroles. If this parameter is used to query or modify directory\nservice roles, but more than 1 configuration exists with a given\nrole id, an error will be returned in order to avoid ambiguous\noperation.\n" }, { "name": "role_names", "value": "", "type": "query", "description": "A comma-separated list of role_names.\nIf there is not at least one resource that matches\neach of the elements of `role_names`, then an error is returned.\nThis cannot be provided together with the `ids`, `names`,\nor `role_ids` query parameters.\nThis query parameter is deprecated for use with directory service\nroles. If this parameter is used to query or modify directory\nservice roles, but more than 1 configuration exists with a given\nrole name, an error will be returned in order to avoid ambiguous\noperation.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an RBAC group configuration setting for manageability.\n" }, { "info": { "name": "Pure Storage DELETE Directory-service/roles", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/roles", "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 an RBAC group configuration setting for manageability.\n" }, { "info": { "name": "Pure Storage GET Directory-services/test", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/test", "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": "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": "Test the configured directory services on the array." }, { "info": { "name": "Pure Storage PATCH Directory-service/test", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services/test", "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 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": "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": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration." }, { "info": { "name": "Pure Storage List Local Directory Services", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/local/directory-services", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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 name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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": "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 local directory services.\n" }, { "info": { "name": "Pure Storage Create Local Directory Service", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/local/directory-services", "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": "Creates a local directory service.\n" }, { "info": { "name": "Pure Storage Modify Local Directory Service", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services/local/directory-services", "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": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies local directory services.\n" }, { "info": { "name": "Pure Storage Delete Local Directory Services", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/local/directory-services", "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": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n" } ] }, "docs": "Deletes local directory services.\nLocal directory service can't be deleted when referenced\nby any server.\n" }, { "info": { "name": "Pure Storage List Local Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/local/groups", "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": "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": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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 name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "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 local groups.\n" }, { "info": { "name": "Pure Storage Create Local Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/local/groups", "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local group.\n" }, { "info": { "name": "Pure Storage Modify Local Groups", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services/local/groups", "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": "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies local groups.\nThe `gids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage Delete Local Groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/local/groups", "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": "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ] }, "docs": "Deletes one or more local groups.\nThe `gids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage List Local Group Memberships", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/local/groups/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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "A comma-separated list of member types for local directory services.\nValid values are `User` and `Group`.\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": "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 local group memberships.\n" }, { "info": { "name": "Pure Storage Create Local Group Membership", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/local/groups/members", "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local group membership with a group.\nThe `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set\ntogether.\n" }, { "info": { "name": "Pure Storage Delete Local Group Membership", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/local/groups/members", "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "A comma-separated list of member types for local directory services.\nValid values are `User` and `Group`.\n" } ] }, "docs": "Deletes one or more local group memberships.\nThe `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set\ntogether.\nThe `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set\ntogether.\n" }, { "info": { "name": "Pure Storage List Local Users", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/local/users", "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": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\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 name specified.\nFor example, `name01`.\nEnter multiple names in comma-separated format.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "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": "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" } ] }, "docs": "Displays a list of local users.\n" }, { "info": { "name": "Pure Storage Create Local User", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/local/users", "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local user.\n" }, { "info": { "name": "Pure Storage Modify Local Users", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/directory-services/local/users", "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies local users.\nThe `uids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage Delete Local Users", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/local/users", "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "sids", "value": "", "type": "query", "description": "Performs the operation on the object SID specified.\nEnter multiple SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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" } ] }, "docs": "Deletes one or more local users.\nThe `uids`, `names`, or `sids` parameter is required, but cannot be set together.\n" }, { "info": { "name": "Pure Storage List Local User Memberships", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/directory-services/local/users/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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\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": "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 local user memberships.\n" }, { "info": { "name": "Pure Storage Create Local User Membership", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/directory-services/local/users/members", "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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a local user membership with a group.\nThe `member_names` or `member_sids` or `member_ids` parameter is required,\nbut cannot be set together.\n" }, { "info": { "name": "Pure Storage Delete Local User Membership", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/directory-services/local/users/members", "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": "group_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": "Performs the operation on the group names specified.\nEnter multiple group names in comma-separated format.\nFor example, `group1,group2`.\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": "local_directory_service_ids", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_names` parameter.\n" }, { "name": "local_directory_service_names", "value": "", "type": "query", "description": "Performs the operation on the specified local directory service. Supports exactly one value.\nWhen not specified, the local directory service connected to the `_array_server` will be used.\nThis cannot be provided in conjunction with the `local_directory_service_ids` parameter.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique local member IDs specified.\nEnter multiple member IDs in comma-separated format. For local group\nIDs refer to group IDs (GID). For local user IDs refer to user IDs (UID).\nThe `member_ids` and `member_names` parameters cannot be provided together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "member_sids", "value": "", "type": "query", "description": "Performs the operation on the specified member SID.\nEnter multiple member SIDs in comma-separated format.\nFor example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.\n" }, { "name": "member_types", "value": "", "type": "query", "description": "A comma-separated list of member types for local directory services.\nValid values are `User` and `Group`.\n" } ] }, "docs": "Deletes one or more local user memberships.\nThe `member_names`, `member_sids`, or `member_ids` parameter is required, but cannot be set\ntogether.\n" } ] } ], "bundled": true }