Pure Storage

Pure Storage Directory Services API

Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services.

Documentation GitHub OpenAPI

Documentation

https://code.purestorage.com/swagger

https://code.purestorage.com

https://static.pure1.purestorage.com/api-swagger/index.html

https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference

Specifications

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-directory-services-api-openapi.yml

Code Examples

https://github.com/PureStorage-OpenConnect/ansible-playbook-examples

https://github.com/PureStorage-OpenConnect/python-scripts

https://github.com/PureStorage-OpenConnect/sqlserver-scripts

https://github.com/PureStorage-OpenConnect/oracle-scripts

https://github.com/PureStorage-OpenConnect/VMware-Scripts

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-array-structure.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

https://pypi.org/project/py-pure-client/

https://github.com/PureStorage-OpenConnect/PureStorage.Pure1

https://github.com/PureStorage-OpenConnect/powershell-toolkit-3

https://github.com/PureStorage-OpenConnect/rest-client

https://github.com/PureStorage-OpenConnect/terraform-provider-flash

https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-example.json

https://github.com/PureStorage-OpenConnect/flashblade-powershell

https://github.com/purestorage/purity_fb_python_client

https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter

https://github.com/PureStorage-OpenConnect/flashblade-mcp-server

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

OpenAPI Specification

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:
     

# --- truncated at 32 KB (144 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-directory-services-api-openapi.yml