openapi: 3.0.1 info: title: FlashArray REST Active Directory Directory Services API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Directory Services description: 'Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services. ' paths: /api/2.52/directory-services: get: tags: - Directory Services summary: Pure Storage List Directory Services Configuration description: 'Displays the directory services configuration settings for manageability. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceGetResponse' post: tags: - Directory Services summary: Pure Storage Create Directory Services Configuration description: 'Creates directory services configuration. All directory services configuration created using this resource will have `services` set to `data`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePost' required: true x-codegen-request-body-name: directory-service responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceResponse' x-codegen-request-body-name: directory-service delete: tags: - Directory Services summary: Pure Storage Delete Directory Services Configuration description: 'Deletes directory services configuration. Directory service configuration must not be referenced by any server nor enabled to be deleted. The built-in "management" directory service cannot be deleted. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Directory Services Configuration description: 'Modifies the directory service configuration. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePatch' required: true x-codegen-request-body-name: directory-service responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceResponse' x-codegen-request-body-name: directory-service /api/2.52/directory-services/roles: get: tags: - Directory Services summary: Pure Storage List Group to Management Access Policy Mappings description: 'Displays access control settings for remote groups. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Group_mapping_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Role_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleGetResponse' post: tags: - Directory Services summary: Pure Storage Create a Group in Management Access Policy Mappings description: 'Creates one or more groups in management access policy mappings. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolePost' required: true x-codegen-request-body-name: directory-service-roles responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleResponse' x-codegen-request-body-name: directory-service-roles delete: tags: - Directory Services summary: Pure Storage Delete Group to Management Access Policy Mappings description: 'Deletes one or more group to management access policy mappings. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Group to Management Access Policy Mappings description: 'Modifies properties of one or more group to management access policy mappings. Modifying management access policies is done at `/directory-services/roles/policies/management-access` instead. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_mapping_names_required' - $ref: '#/components/parameters/Role_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRole' required: true x-codegen-request-body-name: directory-service-roles responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRoleResponse' x-codegen-request-body-name: directory-service-roles /api/2.52/directory-services/roles/policies/management-access: get: tags: - Directory Services summary: Pure Storage List Management Access Policies Attached to a Group to Management Access Policy Mapping description: 'Displays a list of management access policies that are attached to a group to management access policy mappings. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanGetResponse' post: tags: - Directory Services summary: Pure Storage Create a Membership Between a Group to Management Access Policy Mapping with One or More Management Access Policies description: 'Creates a membership between a group to management access policy mapping with one or more management access policies. One of `member_ids` or `member_names` parameter is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyAssignmentPost' required: true x-codegen-request-body-name: policies responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyMemberCleanResponse' x-codegen-request-body-name: policies delete: tags: - Directory Services summary: Pure Storage Delete a Membership Between a Group to Management Access Policy Mapping and One or More Management Access Policies description: 'Deletes a membership between a group to management access policy mapping with one or more management access policies. One of `policy_ids` or `policy_names` is required, and one of `member_ids` or `member_names` is required. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Policy_ids' - $ref: '#/components/parameters/Policy_names' responses: '200': description: OK content: {} /api/2.52/directory-services/test: get: tags: - Directory Services summary: Pure Storage GET Directory-service/test description: The diagnostic utility that verifies the status and configuration of the `directory services` on the `array`. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Server_fqnames' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestGetResultWithResourceErrorContextMultiserverAwareResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/TestGetResultWithResourceErrorContextMultiserverAwareResponse' patch: tags: - Directory Services summary: Pure Storage PATCH Directory-service/test description: 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. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names_required' - $ref: '#/components/parameters/Server_fqnames' requestBody: description: 'The optional `directory service` `configuration` used to temporarily overwrite specific attributes of existing `objects` during diagnostic testing. These modifications are applied only within the scope of the test and do not persist or alter the current active system settings. ' content: application/json: schema: $ref: '#/components/schemas/DirectoryServicePatch' required: false x-codegen-request-body-name: directory-service responses: '200': description: OK headers: X-Request-ID: description: The identifier or attribute provided by the `client` during the initial `request` or automatically generated by the `server` if not specified. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TestPatchResultWithResourceMultiserverAwareResponse' x-codegen-request-body-name: directory-service /api/2.52/directory-services/local/directory-services: get: tags: - Directory Services summary: Pure Storage List Local Directory Services description: 'Displays a list of local directory services. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Directory Service description: 'Creates a local directory service. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Fqnames_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServicePost' required: false x-codegen-request-body-name: local-directory responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' x-codegen-request-body-name: local-directory delete: tags: - Directory Services summary: Pure Storage Delete Local Directory Services description: 'Deletes local directory services. Local directory service can''t be deleted when referenced by any server. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Directory Service description: 'Modifies local directory services. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Fqnames' - $ref: '#/components/parameters/To_member_ids' - $ref: '#/components/parameters/To_member_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryService' required: true x-codegen-request-body-name: local-directory responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' x-codegen-request-body-name: local-directory /api/2.52/directory-services/local/groups: get: tags: - Directory Services summary: Pure Storage List Local Groups description: 'Displays a list of local groups. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalGroupGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group description: 'Creates a local group. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPost' required: false x-codegen-request-body-name: local-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' x-codegen-request-body-name: local-group delete: tags: - Directory Services summary: Pure Storage Delete Local Groups description: 'Deletes one or more local groups. The `gids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Groups description: 'Modifies local groups. The `gids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPatch' required: true x-codegen-request-body-name: local-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' x-codegen-request-body-name: local-group /api/2.52/directory-services/local/groups/members: get: tags: - Directory Services summary: Pure Storage List Local Group Memberships description: 'Displays a list of local group memberships. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group Membership description: 'Creates a local group membership with a group. The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' requestBody: description: 'The `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set together. ' content: application/json: schema: $ref: '#/components/schemas/LocalGroupMembershipPost' required: true x-codegen-request-body-name: local-membership responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' x-codegen-request-body-name: local-membership delete: tags: - Directory Services summary: Pure Storage Delete Local Group Membership description: 'Deletes one or more local group memberships. The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. The `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' responses: '200': description: OK content: {} /api/2.52/directory-services/local/users: get: tags: - Directory Services summary: Pure Storage List Local Users description: 'Displays a list of local users. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Uids' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalUserGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User description: 'Creates a local user. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPost' required: false x-codegen-request-body-name: local-user responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' x-codegen-request-body-name: local-user delete: tags: - Directory Services summary: Pure Storage Delete Local Users description: 'Deletes one or more local users. The `uids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local User description: 'Modifies a local user. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/KeepSessionsOpen' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPatch' required: true x-codegen-request-body-name: local-user responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' x-codegen-request-body-name: local-user /api/2.52/directory-services/local/users/members: get: tags: - Directory Services summary: Pure Storage List Local User Memberships description: 'Displays a list of local user memberships. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User Membership description: 'Creates a local user membership with a group. The `member_names` or `member_sids` or `member_ids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' requestBody: description: 'The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. ' content: application/json: schema: $ref: '#/components/schemas/LocalUserMembershipPost' required: true x-codegen-request-body-name: local-membership responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' x-codegen-request-body-name: local-membership delete: tags: - Directory Services summary: Pure Storage Delete Local User Membership description: 'Deletes one or more local user memberships. The `member_names`, `member_sids`, or `member_ids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Member_types' responses: '200': description: OK content: {} /api/2.26/directory-services: get: tags: - Directory Services summary: Pure Storage GET Directory-services description: List directory service configuration information. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceGetResponse_2' patch: tags: - Directory Services summary: Pure Storage PATCH Directory-services description: 'Modifies and tests the directory service configuration. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryService_2' required: true x-codegen-request-body-name: directory-service responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceResponse' x-codegen-request-body-name: directory-service /api/2.26/directory-services/roles: get: tags: - Directory Services summary: Pure Storage GET Directory-service/roles description: 'Return array''s RBAC group configuration settings for manageability. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_for_directory_service_roles' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names_for_directory_service_roles' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Role_ids' - $ref: '#/components/parameters/Role_names_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolesGetResponse' post: tags: - Directory Services summary: Pure Storage POST Directory-service/roles description: 'Create an RBAC group configuration setting for manageability. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolePost_2' required: true x-codegen-request-body-name: directory-service-roles responses: '200': description: Returns the newly created directory-service-role object. headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolesResponse' x-codegen-request-body-name: directory-service-roles delete: tags: - Directory Services summary: Pure Storage DELETE Directory-service/roles description: 'Delete an RBAC group configuration setting for manageability. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Directory Services summary: Pure Storage PATCH Directory-service/roles description: 'Update an RBAC group configuration setting for manageability. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_for_directory_service_roles' - $ref: '#/components/parameters/Names_for_directory_service_roles' - $ref: '#/components/parameters/Role_ids' - $ref: '#/components/parameters/Role_names_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRole_2' required: true x-codegen-request-body-name: directory-service-roles responses: '200': description: Returns the newly updated directory-service-role object. headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DirectoryServiceRolesResponse' x-codegen-request-body-name: directory-service-roles /api/2.26/directory-services/test: get: tags: - Directory Services summary: Pure Storage GET Directory-services/test description: Test the configured directory services on the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestResultRemoteExecutionGet' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/TestResultRemoteExecutionGet' patch: tags: - Directory Services summary: Pure Storage PATCH Directory-service/test description: 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. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Sort_2' requestBody: description: 'An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests. ' content: application/json: schema: $ref: '#/components/schemas/DirectoryService_2' required: false x-codegen-request-body-name: directory-service responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TestResultRemoteExecution' x-codegen-request-body-name: directory-service /api/2.26/directory-services/local/directory-services: get: tags: - Directory Services summary: Pure Storage List Local Directory Services description: 'Displays a list of local directory services. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NamesSemiRequired' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceGetResponse_2' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceGetResponse_2' post: tags: - Directory Services summary: Pure Storage Create Local Directory Service description: 'Creates a local directory service. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServicePost_2' required: false x-codegen-request-body-name: local-directory responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' delete: tags: - Directory Services summary: Pure Storage Delete Local Directory Services description: 'Deletes local directory services. Local directory service can''t be deleted when referenced by any server. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/NamesSemiRequired' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Directory Service description: 'Modifies local directory services. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/NamesSemiRequired' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryService_2' required: true x-codegen-request-body-name: local-directory responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalDirectoryServiceResponse' /api/2.26/directory-services/local/groups: get: tags: - Directory Services summary: Pure Storage List Local Groups description: 'Displays a list of local groups. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NamesSemiRequired' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalGroupGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group description: 'Creates a local group. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPost' required: false x-codegen-request-body-name: local-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' delete: tags: - Directory Services summary: Pure Storage Delete Local Groups description: 'Deletes one or more local groups. The `gids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/NamesGeneral' - $ref: '#/components/parameters/Sids' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Groups description: 'Modifies local groups. The `gids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Gids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/NamesGeneral' - $ref: '#/components/parameters/Sids' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalGroupPatch' required: true x-codegen-request-body-name: local-group responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalGroupResponse' /api/2.26/directory-services/local/groups/members: get: tags: - Directory Services summary: Pure Storage List Local Group Memberships description: 'Displays a list of local group memberships. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/LocalMemberTypes' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local Group Membership description: 'Creates a local group membership with a group. The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' requestBody: description: 'The `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set together. ' content: application/json: schema: $ref: '#/components/schemas/LocalGroupMembershipPost_2' required: true x-codegen-request-body-name: local-membership responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' delete: tags: - Directory Services summary: Pure Storage Delete Local Group Membership description: 'Deletes one or more local group memberships. The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. The `member_names`, `member_sids`, or `member_gids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/LocalMemberTypes' responses: '200': description: OK content: {} /api/2.26/directory-services/local/users: get: tags: - Directory Services summary: Pure Storage List Local Users description: 'Displays a list of local users. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NamesSemiRequired' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Uids_2' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalUserGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User description: 'Creates a local user. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Names_required_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPost_2' required: false x-codegen-request-body-name: local-user responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' delete: tags: - Directory Services summary: Pure Storage Delete Local Users description: 'Deletes one or more local users. The `uids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/NamesGeneral' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids_2' responses: '200': description: OK content: {} patch: tags: - Directory Services summary: Pure Storage Modify Local Users description: 'Modifies local users. The `uids`, `names`, or `sids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/NamesGeneral' - $ref: '#/components/parameters/Sids' - $ref: '#/components/parameters/Uids_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalUserPatch_2' required: true x-codegen-request-body-name: local-user responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalUserResponse' /api/2.26/directory-services/local/users/members: get: tags: - Directory Services summary: Pure Storage List Local User Memberships description: 'Displays a list of local user memberships. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/LocalMembershipGetResponse' post: tags: - Directory Services summary: Pure Storage Create Local User Membership description: 'Creates a local user membership with a group. The `member_names` or `member_sids` or `member_ids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Member_sids' requestBody: description: 'The `group_names`, `group_sids`, or `group_gids` parameter is required, but cannot be set together. ' content: application/json: schema: $ref: '#/components/schemas/LocalUserMembershipPost_2' required: true x-codegen-request-body-name: local-membership responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocalMembershipResponse' delete: tags: - Directory Services summary: Pure Storage Delete Local User Membership description: 'Deletes one or more local user memberships. The `member_names`, `member_sids`, or `member_ids` parameter is required, but cannot be set together. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Group_gids' - $ref: '#/components/parameters/Local_group_names' - $ref: '#/components/parameters/Group_sids' - $ref: '#/components/parameters/Local_directory_service_ids' - $ref: '#/components/parameters/Local_directory_service_names' - $ref: '#/components/parameters/Local_member_ids' - $ref: '#/components/parameters/Member_names_2' - $ref: '#/components/parameters/Member_sids' - $ref: '#/components/parameters/LocalMemberTypes' responses: '200': description: OK content: {} components: schemas: LocalGroupMembershipPost_2: type: object properties: members: description: 'A list of resources to be a member of the group. ' type: array items: $ref: '#/components/schemas/_localGroupMembershipPostMembers' _realmsReference_2: type: object properties: realms: description: 'Reference to the realms this resource belongs to. The value is set to empty array when the resource lives outside of a realm. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReference_2' DirectoryServiceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/DirectoryServiceResponse' _localDirectoryServiceReference: description: 'An object, which is contained in a local directory service. ' type: object properties: local_directory_service: description: 'Reference to the local directory service the object belongs to. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _referenceWritable: allOf: - $ref: '#/components/schemas/_referenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, `policies/snapshot`, etc. ' type: string x-aliases: - _reference _directoryServiceSmb: description: DEPRECATED - Properties specific to the SMB service. type: object properties: join_ou: description: 'Optional organizational unit where the machine account for the directory service will be created. ' type: string example: OU=my_organizational_unit LocalGroup: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: built_in: description: 'Returns a value of `true` if the local group is built in. Returns a value of `false` if the group has been created manually. ' type: boolean readOnly: true email: description: 'The email address of the local group. ' type: string gid: description: 'The POSIX user ID of this object (group ID). ' type: integer format: int32 name: description: 'The local group name. ' type: string sid: description: 'The SID (Security Identifier) of the local group. ' type: string readOnly: true LocalGroupPatch: allOf: - $ref: '#/components/schemas/_context' - type: object properties: built_in: description: 'Returns a value of `true` if the local group is built in. Returns a value of `false` if the group has been created manually. ' type: boolean readOnly: true email: description: 'The email address of the local group. ' type: string gid: description: 'The POSIX user ID of this object (group ID). ' type: integer format: int32 name: description: 'The local group name. ' type: string sid: description: 'The SID (Security Identifier) of the local group. ' type: string readOnly: true LocalUserMembershipPost: type: object properties: groups: description: 'A list of groups of which the user is a member. ' type: array items: $ref: '#/components/schemas/_localusermembershippostGroups' is_primary: description: Determines whether memberships are primary group memberships or not. type: boolean default: false _builtIn: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true PolicyMemberCleanGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/PolicyMemberCleanResponse' - $ref: '#/components/schemas/_errorContextResponse' LocalUserPost: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: 'If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional. ' type: boolean password: description: 'The password of the local user. This field is only required if the `enabled` field is `true`. ' type: string primary_group: description: 'Local group that would be assigned as the primary group of the local user. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' uid: description: Optional field to set the UID of the local user. type: integer format: int32 DirectoryServicePost: allOf: - $ref: '#/components/schemas/DirectoryServiceCommon' - type: object properties: sources: description: 'List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. ' type: array items: $ref: '#/components/schemas/_reference' PolicyAssignmentPost: type: object properties: policies: description: 'A list of policies to apply to the resource. One of `id` or `name` is required in each `policy`. ' type: array items: $ref: '#/components/schemas/PolicyAssignmentPostPolicy' LocalDirectoryService: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_serverReference' - $ref: '#/components/schemas/LocalDirectoryServicePost' LocalUser: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: built_in: description: 'Returns a value of `true` if the local user is built in. Otherwise returns a value of `false` if the user has been created manually. ' type: boolean readOnly: true email: description: 'The email address of the local user. ' type: string enabled: description: 'Returns a value of `true` if the local user is enabled. ' type: boolean name: description: 'The name of the local user. ' type: string primary_group: description: 'Primary group of the local user. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' sid: description: 'The SID (Security Identifier) of the local user. ' type: string readOnly: true uid: description: 'The POSIX user ID of this object (user ID). ' type: integer format: int32 PolicyMemberCleanResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/PolicyMemberClean' DirectoryServiceRolePost_2: type: object properties: group: description: 'Common Name (CN) of the directory service group containing users with authority level of the specified role name. ' type: string example: groupOfUsers group_base: description: 'Specifies where the configured group is located in the directory tree. ' type: string example: OU=PureGroups,OU=SANManagers management_access_policies: description: 'List of management access policies associated with the directory service role. ' type: array items: $ref: '#/components/schemas/_referenceWritable' role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If a directory service role has exactly one access policy, which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' LocalDirectoryServiceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalDirectoryServiceResponse' _referenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string LocalDirectoryService_2: allOf: - $ref: '#/components/schemas/_context_2' - $ref: '#/components/schemas/_destroyed_readonly' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_realmsReference_2' - $ref: '#/components/schemas/_serverReference_2' - $ref: '#/components/schemas/LocalDirectoryServicePost_2' DirectoryService: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_serverReference' - $ref: '#/components/schemas/DirectoryServiceCommon' - description: Configuration information for the directory service. type: object properties: ca_certificate: description: 'The certificate of the Certificate Authority (CA) that signed the directory servers'' certificate(s), which is used to validate the authenticity of the configured servers. Deprecated, please use ca_certificate_ref instead. Setting this field will result in ca_certificate_ref being updated to _legacy_ds_ca_certificate_. ' type: string ca_certificate_ref: description: 'Reference (ID, name, and resource type) of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' check_peer: description: 'Determines whether or not server authenticity is enforced when a certificate is provided. ' type: boolean example: false management: $ref: '#/components/schemas/_directoryServiceManagement' sources: description: 'List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. ' type: array items: $ref: '#/components/schemas/_referenceWithType' _directoryServiceManagement_2: description: Properties specific to the management service. type: object properties: ssh_public_key_attribute: description: 'SSH public key attribute in the structure of the configured LDAP servers. The attribute field holds the user''s SSH public key. This attribute can represent a single-valued or multi-valued field. If this attribute resolves to a multi-valued field, all valid SSH keys will be used. If the user has specified keys under Admin endpoints, these are used as well. ' type: string example: sshPublicKey user_login_attribute: description: 'User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user''s unique login name. Default value is `sAMAccountName` for Active Directory or `uid` for all other directory services. ' type: string example: email user_object_class: description: 'Value of the object class for a management LDAP user. Defaults to `User` for Active Directory servers, `posixAccount` or `shadowAccount` for OpenLDAP servers dependent on the group type of the server, or `person` for all other directory servers. ' type: string example: inetOrgPerson TestResultRemoteExecutionGet: allOf: - $ref: '#/components/schemas/TestResultRemoteExecution' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/PageInfo_2' - type: object properties: total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string LocalDirectoryServicePost_2: description: 'Configuration information for the local directory service. ' type: object properties: domain: description: 'The name of the domain stored in this local directory service. All users and groups are going to be presented as being part of this domain name. When not set, it defaults to name of the Local Directory Service - name without the container - realm prefix. For example, for object "myrealm::mydomain" the domain name will be "mydomain" where domain name does not have any unique constraint (it can be the same for different local directory services within a realm). ' type: string example: domain _resource: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system), or correspond to something in the environment, like a host or a server. ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A user-specified name. The name must be locally unique and can be changed. ' type: string DirectoryServiceRole: allOf: - $ref: '#/components/schemas/_fixedNameResourceNoId' - $ref: '#/components/schemas/_context' - type: object properties: group: description: 'Group name that contains users with the abilities granted by the associated policies. ' type: string example: groupOfUsers group_base: description: 'Specifies where the configured group is located in the directory tree. ' type: string example: OU=PureGroups,OU=SANManagers management_access_policies: description: 'List of management access policies associated with the group. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' role: description: 'This field has been deprecated. Predecessor to management access policies. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' _directoryServiceManagement: description: Properties specific to the management service. type: object properties: ssh_public_key_attribute: description: 'SSH public key attribute in the structure of the configured LDAP servers. The attribute field that holds the user''s SSH public key. This attribute can represent a single-valued or multi-valued field. If this attribute resolves to a multi-valued field, all valid SSH keys will be used. If the user has specified keys under Admin endpoints, these are used as well. ' type: string example: sshPublicKey user_login_attribute: description: 'User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user''s unique login name. Default value is `sAMAccountName` for Active Directory or `uid` for all other directory services. ' type: string example: email user_object_class: description: 'Value of the object class for a management LDAP user. Defaults to `User` for Active Directory servers, `posixAccount` or `shadowAccount` for OpenLDAP servers dependent on the group type of the server, or `person` for all other directory servers. ' type: string example: inetOrgPerson _destroyed_readonly: type: object properties: destroyed: description: 'When set to `true`, the resource is destroyed and the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by recovering parent container. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered. ' type: boolean readOnly: true time_remaining: description: 'The amount of time left until the resource is permanently eradicated, measured in milliseconds. Before the `time_remaining` period has elapsed, the resource can be recovered. ' type: integer format: int64 readOnly: true _fixedReferenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true LocalDirectoryServiceResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/LocalDirectoryService' DirectoryServiceRolesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/DirectoryServiceRolesResponse' _serverReference: description: 'An object that is server-aware and can be associated to a server. ' type: object properties: server: description: 'Reference to the server the object belongs to. When the value is empty or set to `null` it means the object lives outside of a server scope. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _fixedNameResourceNoId: description: 'An ordinary (as opposed to built-in) resource that can be created, named, or deleted by the user. This might be a virtual resource (e.g., a volume) or correspond to something in the environment, like a host or server. ' type: object properties: name: description: 'A user-specified name. The name must be locally unique and cannot be changed. ' type: string readOnly: true LocalUserPost_2: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: 'If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional. ' type: boolean password: description: 'The password of the local user. This field is only required if the `enabled` field is `true`. ' type: string primary_group: description: 'Local group that would be assigned as the primary group of the local user. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' uid: description: Optional field to set the UID of the local user. type: integer format: int32 DirectoryServiceResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DirectoryService' LocalDirectoryServiceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/LocalDirectoryServiceResponse' - $ref: '#/components/schemas/_errorContextResponse_2' LocalGroupGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalGroupResponse' - $ref: '#/components/schemas/_errorContextResponse' _fixedReference_2: allOf: - $ref: '#/components/schemas/_fixedReferenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true PolicyAssignmentPostPolicy: type: object properties: policy: description: 'Reference to the policy to apply to the resource. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' LocalMembershipResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/LocalMember' LocalUserPatch_2: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: 'If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning. ' type: boolean name: description: 'The local user name. ' type: string password: description: 'The password of the local user. This field is only required if the `enabled` field is true. ' type: string primary_group: description: 'Local group that would be assigned as the primary group of the local user. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' uid: description: Optional field to set the UID of the local user. type: integer format: int32 TestPatchResultWithResourceMultiserverAwareResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithNoIdResourceMultiserverAware' PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 _localGroupMembershipPostMembers: type: object properties: member: description: 'Reference to the resource that will be a member of the group. The `id` or `name` parameter is required, but cannot be set together. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' member_id: description: The member ID that should be mapped. type: integer format: int32 _errorContextResponse: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorcontextresponseErrors' DirectoryServiceCommon: allOf: - $ref: '#/components/schemas/_context' - description: 'Configuration information for the directory service. ' type: object properties: base_dn: description: 'Base of the Distinguished Name (DN) of the directory service groups. ' type: string example: DC=mycompany,DC=com bind_password: description: 'Masked password used to query the directory. ' type: string example: '****' bind_user: description: 'Username used to query the directory. ' type: string example: CN=John,OU=Users,DC=example,DC=com enabled: description: 'The directory service is either enabled or disabled. ' type: boolean example: true services: description: 'Services for which the directory service configuration is used. ' type: array readOnly: true items: type: string description: 'Valid values are `data` and `management`. ' example: data example: - data - management uris: description: 'List of URIs for the configured directory servers. ' type: array items: pattern: ^(ldap|ldaps) type: string example: ldaps://ad1.mycompany.com TestResult: type: object properties: component_address: description: Address of the component running the test. type: string example: 10.230.94.21 component_name: description: Name of the component running the test. type: string example: CT0 description: description: What the test is doing. type: string example: Testing phonehome connectivity destination: description: The URI of the target server being tested. type: string example: ra.cloud-support.purestorage.com enabled: description: 'Whether the object being tested is enabled or not. Returns a value of `true` if the the service is enabled. Returns a value of `false` if the service is disabled. ' type: boolean example: true result_details: description: Additional information about the test result. type: string example: Timeout connecting to phonehome endpoint success: description: 'Whether the object being tested passed the test or not. Returns a value of `true` if the specified test has succeeded. Returns a value of `false` if the specified test has failed. ' type: boolean test_type: description: 'Displays the type of test being performed. The returned values are determined by the `resource` being tested and its configuration. Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`, `phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`, `storage-admin-group-searching`, and `validate-ntp-configuration`. ' type: string example: phonehome _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors LocalGroupPost: type: object properties: email: description: 'Optional field to set the email address of the local group. ' type: string gid: description: 'Optional field to set the GID of the local group. ' type: integer format: int32 _errorContextResponse_2: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorContextResponseErrors' DirectoryServiceRoleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryServiceRoleResponse' - $ref: '#/components/schemas/_errorContextResponse' _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference DirectoryServiceRoleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DirectoryServiceRole' LocalUserResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/LocalUser' _directoryServiceNfs: description: Properties specific to the NFS service. type: object properties: nis_domains: description: NIS domains to search. type: array items: type: string example: ypdomain nis_servers: description: 'A list of the IP addresses or hostnames of NIS servers to search. ' type: array items: type: string example: 181.44.543.12 _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _context_2: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' DirectoryServiceRolePost: type: object properties: group: description: 'Group name that contains users with the abilities granted by the associated policies. ' type: string example: groupOfUsers group_base: description: 'Specifies where the configured group is located in the directory tree. ' type: string example: OU=PureGroups,OU=SANManagers management_access_policies: description: 'List of management access policies to associate with the group. ' type: array items: $ref: '#/components/schemas/_referenceWithType' role: description: 'This field has been deprecated. Predecessor to management access policies. Can be set to the premade policy of the same name. Cannot be set with management_access_policies. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' TestResultRemoteExecution: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithContext' _reference_2: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string readOnly: true x-aliases: - _referenceWithFixedType _localUserMembershipPostGroups: type: object properties: group: description: 'Reference to a group of which the user is a member. The `id` or `name` parameter is required, but cannot be set together. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' group_gid: description: The group GID that should be mapped. type: integer format: int32 TestResultWithContext: allOf: - $ref: '#/components/schemas/TestResult_2' - $ref: '#/components/schemas/_context_2' PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 DirectoryServiceRolesResponse: type: object properties: items: description: A list of directory service role mapping configuration objects. type: array items: $ref: '#/components/schemas/DirectoryServiceRole_2' TestResult_2: type: object properties: component_address: description: Address of the component running the test. type: string example: 10.230.94.21 component_name: description: Name of the component running the test. type: string example: fm1 description: description: What the test is doing. type: string example: Testing phonehome connectivity destination: description: The URI of the target server being tested. type: string example: ra.cloud-support.purestorage.com enabled: description: Is the service enabled or not? type: boolean example: true resource: description: A reference to the object being tested. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' result_details: description: Additional information about the test result. type: string example: Timeout connecting to phonehome endpoint success: description: 'Returns a value of `true` if the specified test succeeded. Returns a value of `false` if the specified test failed. ' type: boolean test_type: description: 'Displays the type of test being performed. The returned values are determined by the `resource` being tested and its configuration. ' type: string example: phonehome TestGetResultWithResourceErrorContextMultiserverAwareResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: type: array items: $ref: '#/components/schemas/TestResultWithNoIdResourceMultiserverAware' _localusermembershippostGroups: type: object properties: group: description: 'Reference to a group of which the user is a member. The `id` or `name` parameter is required, but cannot be set together. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' group_gid: description: The group GID that should be mapped. type: integer format: int32 _errorContextResponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. LocalUserGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalUserResponse' - $ref: '#/components/schemas/_errorContextResponse' _fixedReferenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true PolicyMemberClean: allOf: - $ref: '#/components/schemas/_context' - type: object properties: member: description: 'Reference to the resource that the policy is applied to. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' policy: description: 'Reference to the policy. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _referenceWithType: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string x-aliases: - _reference DirectoryService_2: allOf: - $ref: '#/components/schemas/_builtIn' - description: Configuration information for the directory service. type: object properties: base_dn: description: 'Base of the Distinguished Name (DN) of the directory service groups. ' type: string example: DC=mycompany,DC=com bind_password: description: Obfuscated password used to query the directory. type: string example: '****' bind_user: description: Username used to query the directory. type: string example: CN=John,OU=Users,DC=example,DC=com ca_certificate: description: 'CA certificate used to validate the authenticity of the configured servers. ' title: Reference allOf: - $ref: '#/components/schemas/_reference_2' ca_certificate_group: description: 'A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers. ' title: Reference allOf: - $ref: '#/components/schemas/_reference_2' enabled: description: Is the directory service enabled or not? type: boolean example: true management: $ref: '#/components/schemas/_directoryServiceManagement_2' nfs: $ref: '#/components/schemas/_directoryServiceNfs' services: description: 'Services that the directory service configuration is used for. ' type: array readOnly: true items: type: string description: 'Valid values include `nfs` and `management`. ' example: management example: - management smb: $ref: '#/components/schemas/_directoryServiceSmb' uris: description: List of URIs for the configured directory servers. type: array maxItems: 30 items: pattern: ^(ldap|ldaps) type: string example: ldaps://ad1.mycompany.com LocalUserPatch: type: object properties: email: description: Optional field to set the email of the local user. type: string enabled: description: 'If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning. ' type: boolean name: description: 'The local user name. ' type: string password: description: 'The password of the local user. This field is only required if the `enabled` field is true. ' type: string primary_group: description: 'Local group that would be assigned as the primary group of the local user. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' uid: description: Optional field to set the UID of the local user. type: integer format: int32 LocalGroupResponse: type: object properties: items: description: 'Displays a list of all items after filtering. The values are displayed for each name, if meaningful. ' type: array items: $ref: '#/components/schemas/LocalGroup' TestResultWithNoIdResourceMultiserverAware: allOf: - $ref: '#/components/schemas/TestResult' - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_realmsReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: resource: description: A reference to the object being tested. title: FixedReferenceNoId allOf: - $ref: '#/components/schemas/_fixedReferenceNoId' DirectoryServiceRole_2: type: object properties: group: description: 'Common Name (CN) of the directory service group containing users with authority level of the specified role name. ' type: string example: groupOfUsers group_base: description: 'Specifies where the configured group is located in the directory tree. ' type: string example: OU=PureGroups,OU=SANManagers id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true management_access_policies: description: 'List of management access policies associated with the directory service role. ' readOnly: true type: array items: $ref: '#/components/schemas/_fixedReference_2' name: description: Name of the role mapping object. type: string readOnly: true role: description: 'Deprecated. `role` is deprecated in favor of `management_access_policies`, but remains for backwards compatibility. If a directory service role has exactly one access policy, which corresponds to a valid legacy role of the same name, `role` will be a reference to that role. Otherwise, it will be `null`. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' LocalDirectoryServicePost: description: 'Configuration information for the local directory service. ' type: object properties: domain: description: 'The name of the domain stored in this local directory service. All users and groups are going to be presented as being part of this domain name. When not set, it defaults to name of the Local Directory Service. For example, for object "mydomain" the domain name will be "mydomain" where domain name does not have any unique constraint (it can be the same for different local directory services within an array. ' type: string example: domain LocalGroupMembershipPost: type: object properties: members: description: 'A list of resources to be a member of the group. ' type: array items: $ref: '#/components/schemas/_localgroupmembershippostMembers' DirectoryServicePatch: allOf: - $ref: '#/components/schemas/_newFqname' - $ref: '#/components/schemas/DirectoryServiceCommon' - description: null type: object properties: ca_certificate: description: 'The certificate of the Certificate Authority (CA) that signed the directory servers'' certificate(s), which is used to validate the authenticity of the configured servers. Deprecated, please use ca_certificate_ref instead. Setting this field will result in ca_certificate_ref being updated to _legacy_ds_ca_certificate_. ' type: string ca_certificate_ref: description: 'Reference (ID, name, and resource type) of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' check_peer: description: 'Determines whether or not server authenticity is enforced when a certificate is provided. ' type: boolean example: false management: $ref: '#/components/schemas/_directoryServiceManagement' sources: description: 'List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. ' type: array items: $ref: '#/components/schemas/_reference' LocalUserMembershipPost_2: type: object properties: groups: description: 'A list of groups of which the user is a member. ' type: array items: $ref: '#/components/schemas/_localUserMembershipPostGroups' is_primary: description: Determines whether memberships are primary group memberships or not. type: boolean default: false _localgroupmembershippostMembers: type: object properties: member: description: 'Reference to the resource that will be a member of the group. The `id` or `name` parameter is required, but cannot be set together. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' member_id: description: The member ID that should be mapped. type: integer format: int32 LocalMember: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_localDirectoryServiceReference' - $ref: '#/components/schemas/_serverReference' - type: object properties: group: description: 'Reference to the group to which the member belongs. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' group_gid: description: 'GID of the group to which the member belongs. ' type: integer format: int32 is_primary_group: description: 'When a membership of `member_type` has the value `User`, this specifies whether this membership is a primary-group mapping or not. In any other case, this field will be `false`. ' type: boolean readOnly: true member: description: 'Reference to the member of the group. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' member_id: description: 'GID if the `member_type` is `Group` and UID if the `member_type` is `User`. ' type: integer format: int32 DirectoryServiceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/DirectoryServiceResponse' - $ref: '#/components/schemas/_errorContextResponse' _newFqname: type: object properties: name: description: 'The new name for the resource. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `name01,realm01::name01,realm01::pod01::name01`. ' type: string _serverReference_2: description: 'An object that is server-aware and can be associated to a server. ' type: object properties: server: description: 'Reference to the server the object belongs to. When the value is empty or set to `null` it means the object lives outside of a server scope. ' readOnly: true title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' _realmsReference: type: object properties: realms: description: 'Reference to the realms this resource belongs to. The value is set to empty array when the resource lives outside of a realm. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceWithType' _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType LocalMembershipGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/LocalMembershipResponse' - $ref: '#/components/schemas/_errorContextResponse' parameters: Fqnames: name: names in: query description: 'Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `name01,pod01::name01`. ' style: form explode: false schema: type: array items: type: string To_member_ids: name: to_member_ids in: query description: 'The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format. ' style: form explode: false schema: type: array items: type: string Fqnames_required: name: names in: query description: 'Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `name01,pod01::name01`. ' required: true style: form explode: false schema: type: array items: type: string Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 Local_member_ids: name: member_ids in: query description: 'Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together. ' style: form explode: false schema: type: array items: type: integer format: int32 Names_for_directory_service_roles: name: names in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `names`, then an error is returned. This cannot be provided together with the `ids`, `role_names`, or `role_ids` query parameters. ' style: form explode: false schema: type: array items: type: string To_member_names: name: to_member_names in: query description: 'The resource will be moved to the specified local member realm or array. Enter multiple names in a comma-separated format. ' style: form explode: false schema: type: array items: type: string Group_gids: name: group_gids in: query description: 'Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`. ' style: form explode: false schema: type: array items: type: integer format: int32 Ids: name: ids in: 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" style: form explode: false schema: type: array items: type: string Member_sids: name: member_sids in: query description: 'Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. ' style: form explode: false schema: type: array items: type: string Group_mapping_names: name: names in: query description: 'Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format. ' style: form explode: false schema: type: array items: type: string Sort: name: sort in: 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" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false Policy_ids: name: policy_ids in: query description: 'Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string Group_sids: name: group_sids in: query description: 'Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. ' style: form explode: false schema: type: array items: type: string NamesSemiRequired: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Member_names: name: member_names in: query description: 'Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`. ' style: form explode: false schema: type: array items: type: string Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Server_fqnames: name: server_names in: query description: 'Server names providing the context for the operation. Names are expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, `server01,server02`. ' style: form explode: false schema: type: array items: type: string Member_names_2: name: member_names in: query description: 'A comma-separated list of member names. ' style: form explode: false schema: type: array items: type: string Names_required: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. ' required: true style: form explode: false schema: type: array items: type: string Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Uids: name: uids in: query description: 'A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, `423,51234`. ' style: form explode: false schema: type: array items: type: integer format: int32 Role_names: name: role_names in: query description: 'This field has been deprecated. ' style: form explode: false schema: type: array items: type: string Policy_names: name: policy_names in: query description: 'Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Context_names: name: context_names in: query description: 'Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' style: form explode: false schema: type: array items: type: string Uids_2: name: uids in: query description: 'A comma-separated list of user IDs (UIDs). Enter multiple user IDs in comma-separated format. For example, `423,51234`. ' style: form explode: false schema: type: array items: type: integer format: int32 Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string Member_ids: name: member_ids in: query description: 'Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Local_directory_service_names: name: local_directory_service_names in: query description: 'Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the `_array_server` will be used. This cannot be provided in conjunction with the `local_directory_service_ids` parameter. ' style: form explode: false schema: type: array items: type: string KeepSessionsOpen: name: keep_open_sessions in: query description: 'If set to `true`, the session does not expire. If set to `false`, when the user is disabled or password is changed, the session expires. If not specified, defaults to `false`. ' schema: type: boolean Role_ids: name: role_ids in: query description: 'A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of `role_ids`, then an error is returned. This cannot be provided together with the `ids`, `names` or `role_names` query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role id, an error will be returned in order to avoid ambiguous operation. ' style: form explode: false schema: type: array items: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean Ids_for_directory_service_roles: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `names`, `role_names`, or `role_ids` query parameters. ' style: form explode: false schema: type: array items: type: string Sids: name: sids in: query description: 'Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`. ' style: form explode: false schema: type: array items: type: string IdsSemiRequired: name: ids in: query description: 'Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string LocalMemberTypes: name: member_types in: query description: 'A comma-separated list of member types for local directory services. Valid values are `User` and `Group`. ' style: form explode: false schema: type: array items: type: string Names_required_2: name: names in: query description: 'A comma-separated list of resource names. ' required: true style: form explode: false schema: type: array items: type: string Member_types: name: member_types in: query description: 'Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`. ' style: form explode: false schema: type: array items: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Local_group_names: name: group_names in: query description: 'Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Role_names_2: name: role_names in: query description: 'A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of `role_names`, then an error is returned. This cannot be provided together with the `ids`, `names`, or `role_ids` query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role name, an error will be returned in order to avoid ambiguous operation. ' style: form explode: false schema: type: array items: type: string Gids: name: gids in: query description: 'Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`. ' style: form explode: false schema: type: array items: type: integer format: int32 NamesGeneral: name: names in: query description: 'Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Local_directory_service_ids: name: local_directory_service_ids in: query description: 'Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the `_array_server` will be used. This cannot be provided in conjunction with the `local_directory_service_names` parameter. ' style: form explode: false schema: type: array items: type: string Destroyed: name: destroyed in: query description: 'If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds. If object name(s) or id(s) are specified, then each object referenced must exist. If `destroyed` is set to `true`, then each object referenced must also be destroyed. If `destroyed` is set to `false`, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met. ' schema: type: boolean Group_mapping_names_required: name: names in: query description: 'Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format. ' required: true style: form explode: false schema: type: array items: type: string