Pure Storage Administrators API

The FlashArray has a single default administrative account named pureuser. The administrator can add, delete, and modify administrators on the array. Administrators are assigned management access policies to give different levels of permissions.

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-array-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

🔗
SDKs
https://pypi.org/project/py-pure-client/
🔗
SDKs
https://github.com/PureStorage-OpenConnect/PureStorage.Pure1
🔗
SDKs
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
🔗
SDKs
https://github.com/PureStorage-OpenConnect/rest-client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/terraform-provider-flash
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-example.json
🔗
SDKs
https://github.com/PureStorage-OpenConnect/flashblade-powershell
🔗
SDKs
https://github.com/purestorage/purity_fb_python_client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter
🔗
Tools
https://github.com/PureStorage-OpenConnect/flashblade-mcp-server
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

OpenAPI Specification

pure-storage-administrators-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Administrators 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: Administrators
  description: 'The FlashArray has a single default administrative account named pureuser. The administrator can

    add, delete, and modify administrators on the array. Administrators are assigned management

    access policies to give different levels of permissions.

    '
paths:
  /api/2.52/admins:
    get:
      tags:
      - Administrators
      summary: Pure Storage List Administrators
      description: 'Displays a list of administrators.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Expose_api_token'
      - $ref: '#/components/parameters/Expose_public_key'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $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/AdminGetResponse'
    post:
      tags:
      - Administrators
      summary: Pure Storage Create an Administrator
      description: 'Creates an administrator.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminPost'
        required: true
        x-codegen-request-body-name: admin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminResponse'
      x-codegen-request-body-name: admin
    delete:
      tags:
      - Administrators
      summary: Pure Storage Delete an Administrator
      description: 'Deletes the specified administrator.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Administrators
      summary: Pure Storage Modify an Administrator
      description: 'Modifies properties for the specified administrator.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminPatch'
        required: true
        x-codegen-request-body-name: admin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminResponse'
      x-codegen-request-body-name: admin
  /api/2.52/admins/policies/management-access:
    get:
      tags:
      - Administrators
      summary: Pure Storage List Management Access Policies Attached to Administrators
      description: 'Displays a list of management access policies that are attached to administrators.


        '
      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:
      - Administrators
      summary: Pure Storage Create a Membership Between an Administrator with One or More Management Access Policies.
      description: 'Creates a membership between an administrator 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:
      - Administrators
      summary: Pure Storage Delete a Membership Between an Administrator and One or More Management Access Policies
      description: 'Deletes a membership between an administrator 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/admins/api-tokens:
    get:
      tags:
      - Administrators
      summary: Pure Storage List API Tokens
      description: Displays API tokens for the specified administrators.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Expose_api_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $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/AdminApiTokenGetResponse'
    post:
      tags:
      - Administrators
      summary: Pure Storage Create API Tokens
      description: Creates API tokens for the specified administrators.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Timeout'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApiTokenResponse'
    delete:
      tags:
      - Administrators
      summary: Pure Storage Delete API Tokens
      description: Deletes the API tokens of the specified administrators.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/admins/cache:
    get:
      tags:
      - Administrators
      summary: Pure Storage List Administrator Cache Entries
      description: 'Displays entries in the administrator cache.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $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/AdminCacheGetResponse'
    put:
      tags:
      - Administrators
      summary: Pure Storage Update or Refresh Entries in the Administrator Cache
      description: 'Updates entries in the cache for administrators who currently do not have a cache entry,

        otherwise refreshes the existing entry.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminCacheResponse'
    delete:
      tags:
      - Administrators
      summary: Pure Storage Delete Cache Entries
      description: 'Deletes all entries from the administrator cache.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Remove_all_entries'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/admins/settings:
    get:
      tags:
      - Administrators
      summary: Pure Storage List Administrator Settings
      description: 'Displays the global administrator settings for the array.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $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/AdminSettingsGetResponse'
    patch:
      tags:
      - Administrators
      summary: Pure Storage Modify Administrator Settings
      description: 'Modifies the global administrator settings for the array.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminSettings'
        required: true
        x-codegen-request-body-name: admin-settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminSettingsResponse'
      x-codegen-request-body-name: admin-settings
  /api/2.26/admins:
    get:
      tags:
      - Administrators
      summary: Pure Storage GET Admins
      description: List the administrator's attributes, including the API token and public key.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Expose_api_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $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/AdminGetResponse_2'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGetResponse_2'
    post:
      tags:
      - Administrators
      summary: Pure Storage POST Admins
      description: Create a new local administrator.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminPost_2'
        required: true
        x-codegen-request-body-name: admin
      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/AdminResponse_2'
      x-codegen-request-body-name: admin
    delete:
      tags:
      - Administrators
      summary: Pure Storage DELETE Admins
      description: Delete a local administrator..
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $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:
      - Administrators
      summary: Pure Storage PATCH Admins
      description: Modify the attributes of an administrator.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminPatch_2'
        required: true
        x-codegen-request-body-name: admin
      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/AdminResponse_2'
      x-codegen-request-body-name: admin
  /api/2.26/admins/api-tokens:
    get:
      tags:
      - Administrators
      summary: Pure Storage GET Admins/api-tokens
      description: Displays API tokens for the specified administrators.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Admin_ids'
      - $ref: '#/components/parameters/Admin_names'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Expose_api_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $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/AdminApiTokenGetResponse_2'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApiTokenGetResponse_2'
    post:
      tags:
      - Administrators
      summary: Pure Storage POST Admins/api-tokens
      description: Creates API tokens for the specified administrators.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Admin_ids'
      - $ref: '#/components/parameters/Admin_names'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Timeout'
      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/AdminApiTokenResponse_2'
    delete:
      tags:
      - Administrators
      summary: Pure Storage DELETE Admins/api-tokens
      description: Deletes the API tokens of the specified administrators.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Admin_ids'
      - $ref: '#/components/parameters/Admin_names'
      - $ref: '#/components/parameters/Context_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
  /api/2.26/admins/cache:
    get:
      tags:
      - Administrators
      summary: Pure Storage GET Admins/cache
      description: List cached administrator information used to determine role based access control privileges.
      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'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Refresh'
      - $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/AdminCacheGetResponse_2'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminCacheGetResponse_2'
    delete:
      tags:
      - Administrators
      summary: Pure Storage DELETE Admins/cache
      description: Delete cached administrator role information by name or ID.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $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: {}
  /api/2.26/admins/settings:
    get:
      tags:
      - Administrators
      summary: Pure Storage List Global Admin Settings
      description: Return global admin settings.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $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/AdminSettingsGetResponse_2'
    patch:
      tags:
      - Administrators
      summary: Pure Storage Update Global Admin Settings
      description: Update properties for global admin settings.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminSetting'
        required: true
        x-codegen-request-body-name: admin-setting
      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/AdminSettingsResponse_2'
      x-codegen-request-body-name: admin-setting
components:
  schemas:
    _apiToken:
      description: API token
      type: object
      properties:
        created_at:
          description: Creation time in milliseconds since the UNIX epoch.
          type: integer
          format: int64
          readOnly: true
        expires_at:
          description: Expiration time in milliseconds since the UNIX epoch.
          type: integer
          format: int64
          readOnly: true
        token:
          type: string
          readOnly: true
      x-readOnly: true
    AdminCacheResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AdminCache'
    _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
    AdminApiToken_2:
      allOf:
      - $ref: '#/components/schemas/_context_2'
      - type: object
        properties:
          admin:
            description: A reference to the admin to whom this token belongs.
            title: Reference
            allOf:
            - $ref: '#/components/schemas/_reference_2'
          api_token:
            title: ApiToken
            allOf:
            - $ref: '#/components/schemas/_apiToken'
        x-readOnly: true
    AdminPost_2:
      description: 'An administrative user, who has rights to login and manage the array in some capacity.

        '
      type: object
      properties:
        admin_type:
          description: 'The type of admin account. Set to `service-account` to create a REST-only service account. Service accounts

            do not have passwords and cannot have associated public keys. If not specified, defaults to `local-user`.

            '
          type: string
          example: service-account
        management_access_policies:
          description: 'List of management access policies associated with the administrator.

            '
          type: array
          items:
            $ref: '#/components/schemas/_referenceWritable'
        password:
          description: New user password.
          type: string
        public_key:
          description: Public key for SSH access. Supported key types include `Ed25519` and `RSA`.
          type: string
        role:
          description: 'Deprecated.

            `role` is deprecated in favor of `management_access_policies`, but remains for

            backwards compatibility. If an administrator 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'
    _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
    AdminApiTokenResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AdminApiToken'
    AdminGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/AdminResponse'
    AdminApiTokenGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/AdminApiTokenResponse_2'
      - $ref: '#/components/schemas/_errorContextResponse_2'
    PolicyMemberCleanGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PolicyMemberCleanResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    AdminSettingsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AdminSettings'
    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'
    AdminApiTokenGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/AdminApiTokenResponse'
    AdminSetting:
      type: object
      properties:
        lockout_duration:
          description: 'The lockout duration, in milliseconds, if a user has reached the

            maximum number of login attempts. Ranges from 1 second to 90 days.

            Default value is `null`. Use 0 to reset the value to `null`.

            '
          type: integer
          format: int64
          minimum: 0
          maximum: 7776000000
          example: 3600000
        max_login_attempts:
          description: 'The maximum number of failed login attempts allowed before the user is locked out.

            Default value is `null`. Use 0 to reset the value to `null`.

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 100
          example: 10
        min_password_length:
          description: 'The minimum password length. If not specified, defaults to 1 character.

            '
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 1
    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'
    AdminSettingsResponse_2:
      type: object
      properties:
        items:
          description: Returns global admin settings.
          type: array
          items:
            $ref: '#/components/schemas/AdminSetting'
    _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
    _referenceNoId:
      type: object
      properties:
        name:
          description: 'The resource name, such as volume name, pod name, snapshot name, and so on.

            '
          type: string
    AdminCache:
      allOf:
      - $ref: '#/components/schemas/_fixedNameResourceNoId'
      - description: 'A cache entry for the admin cache to quickly look up admin roles.

          '
        type: object
        properties:
          authorization_model:
            description: 'The source of the access policy mapping. A value of `static` indicates

              that policies are configured locally on the array, while a value of

              `dynamic` indicates that they are determined by an external system

              such as `LDAP` or an `IdP`.

              '
            type: string
            example: static
          cached_at:
            description: 'Time when the entry was added to the cache, in milliseconds since the

              UNIX epoch.

              '
            type: integer
            format: int64
            readOnly: true
          management_access_policies:
            description: 'List of management access policies associated with the administrator.

              '
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/_fixedReferenceWithType'
          role:
            title: AdminRole
            allOf:
            - $ref: '#/components/schemas/_adminRole'
    Admin:
      allOf:
      - $ref: '#/components/schemas/_fixedNameResourceNoId'
      - description: Administrator account.
        ty

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