Pure Storage Policies - User and Group Quota Policy API

A user-group-quota policy manages NFS and SMB quota configuration applicable for file owners in a filesystems. Rules can be set to configure quotas for specific users or groups, user-default and group-default.

Operations 12

GET /api/2.26/user-group-quota-policies Pure Storage GET User-group-quota-policies
POST /api/2.26/user-group-quota-policies Pure Storage POST User-group-quota-policies
PATCH /api/2.26/user-group-quota-policies Pure Storage PATCH User-group-quota-policies
DELETE /api/2.26/user-group-quota-policies Pure Storage DELETE User-group-quota-policies
GET /api/2.26/user-group-quota-policies/rules Pure Storage GET User-group-quota-policies/rules
POST /api/2.26/user-group-quota-policies/rules Pure Storage POST User-group-quota-policies/rules
DELETE /api/2.26/user-group-quota-policies/rules Pure Storage DELETE User-group-quota-policies/rules
PATCH /api/2.26/user-group-quota-policies/rules Pure Storage PATCH User-group-quota-policies/rules
GET /api/2.26/user-group-quota-policies/file-systems Pure Storage GET User-group-quota-policies/file-systems
POST /api/2.26/user-group-quota-policies/file-systems Pure Storage POST User-group-quota-policies/file-systems
DELETE /api/2.26/user-group-quota-policies/file-systems Pure Storage DELETE User-group-quota-policies/file-systems
GET /api/2.26/user-group-quota-policies/members Pure Storage GET User-group-quota-policies/members

Documentation

Specifications

Code Examples

Schemas & Data

📊
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-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
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pure-storage-policies-user-and-group-quota-policy-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pure-storage-policies-user-and-group-quota-policy-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Policies - User and Group Quota Policy 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: Policies - User and Group Quota Policy
  description: A user-group-quota policy manages NFS and SMB quota configuration applicable for file owners in a filesystems. Rules can be set to configure quotas for specific users or groups, user-default and group-default.
paths:
  /api/2.26/user-group-quota-policies:
    get:
      summary: Pure Storage GET User-group-quota-policies
      description: Displays a list of quota policies for users and groups for file systems.
      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'
      - $ref: '#/components/parameters/Sort'
      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/UserGroupQuotaPoliciesGetResponse'
        '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/UserGroupQuotaPoliciesGetResponse'
      tags:
      - Policies - User and Group Quota Policy
    post:
      summary: Pure Storage POST User-group-quota-policies
      description: Creates a new user-group-quota policy for file systems. To import existing purequota and purefs configured quotas to a new policy, the file_system_names or file_system_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/File_system_ids'
      - $ref: '#/components/parameters/File_system_names'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupQuotaPolicyPost'
        required: true
        x-codegen-request-body-name: policy
      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/UserGroupQuotaPoliciesResponse'
      tags:
      - Policies - User and Group Quota Policy
    patch:
      summary: Pure Storage PATCH User-group-quota-policies
      description: Modifies an existing user-group-quota policy's attributes.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Ignore_usage_user_group_quotas'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Versions'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupQuotaPolicy'
        required: true
        x-codegen-request-body-name: policy
      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/UserGroupQuotaPoliciesResponse'
      tags:
      - Policies - User and Group Quota Policy
    delete:
      summary: Pure Storage DELETE User-group-quota-policies
      description: Deletes one or more user-group-quota policies.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Versions'
      responses:
        200:
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
      tags:
      - Policies - User and Group Quota Policy
  /api/2.26/user-group-quota-policies/rules:
    get:
      summary: Pure Storage GET User-group-quota-policies/rules
      description: 'Displays a list of user-group-quota policy rules.

        '
      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'
      - $ref: '#/components/parameters/Sort'
      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/UserGroupQuotaPolicyRulesGetResponse'
        '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/UserGroupQuotaPolicyRulesGetResponse'
      tags:
      - Policies - User and Group Quota Policy
    post:
      summary: Pure Storage POST User-group-quota-policies/rules
      description: 'Adds a quota policy rule for users or groups.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ignore_usage_user_group_quotas'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupQuotaPolicyRulePost'
        required: true
        x-codegen-request-body-name: rule
      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/UserGroupQuotaPolicyRulesResponse'
      tags:
      - Policies - User and Group Quota Policy
    delete:
      summary: Pure Storage DELETE User-group-quota-policies/rules
      description: 'Deletes one or more user-group-quota policy rules.


        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      responses:
        200:
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
      tags:
      - Policies - User and Group Quota Policy
    patch:
      summary: Pure Storage PATCH User-group-quota-policies/rules
      description: 'Modifies an user-group-quota policy rule.

        Only the following fields can be modified - `notification` and `quota-limit`.


        '
      parameters:
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Ignore_usage_user_group_quotas'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupQuotaPolicyRulePatch'
        required: true
        x-codegen-request-body-name: rule
      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/UserGroupQuotaPolicyRulesResponse'
      tags:
      - Policies - User and Group Quota Policy
  /api/2.26/user-group-quota-policies/file-systems:
    get:
      summary: Pure Storage GET User-group-quota-policies/file-systems
      description: Lists file systems mapped to a user-group-quota policy.
      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/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'
      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/UserGroupQuotaPoliciesMembersGetResponse'
        '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/UserGroupQuotaPoliciesMembersGetResponse'
      tags:
      - Policies - User and Group Quota Policy
    post:
      summary: Pure Storage POST User-group-quota-policies/file-systems
      description: Maps a user-group-quota policy to a file system.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Delete_existing_user_group_quota_settings'
      - $ref: '#/components/parameters/Ignore_usage_user_group_quotas'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      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/UserGroupQuotaPoliciesMembersResponse'
      tags:
      - Policies - User and Group Quota Policy
    delete:
      summary: Pure Storage DELETE User-group-quota-policies/file-systems
      description: Removes the user-group-quota policy mapped to a file system.
      parameters:
      - $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
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
      tags:
      - Policies - User and Group Quota Policy
  /api/2.26/user-group-quota-policies/members:
    get:
      tags:
      - Policies - User and Group Quota Policy
      summary: Pure Storage GET User-group-quota-policies/members
      description: Lists file systems mapped to a user-group-quota policy.
      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/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'
      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/UserGroupQuotaPoliciesMembersGetResponse'
        '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/UserGroupQuotaPoliciesMembersGetResponse'
components:
  schemas:
    UserGroupQuotaPolicyRuleBase:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - properties:
          enforced:
            description: 'If set to `true`, this rule describes an enforced quota. A quota error

              is issued if the logical space usage of the subject exceeds the limit value

              described in this rule.

              '
            type: boolean
          notifications:
            description: 'Specifies whether to send notifications to the affected quota subject or not.

              Valid values are `None` and `Account`.

              Defaults to `Account`.

              '
            type: string
          policy:
            description: The policy to which this rule belongs.
            readOnly: true
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          policy_version:
            description: 'The policy''s version. This can be used when updating the

              resource to ensure there aren''t any updates to the policy since the resource was read.

              '
            type: string
            readOnly: true
          quota_limit:
            description: 'The limit of the quota (in bytes) for the specified user, cannot be `0`.

              If specified, this value will override the default quota for that particular subject type.

              '
            type: integer
            format: int64
          quota_type:
            description: 'Specifies quota type for the quota policy. Valid values are `user`, `group`,

              `user-default`and `group-default`.

              `user-default` and `group-default` cannot be specified with a subject.

              '
            type: string
          subject:
            description: The user or group subject on which this rule is applied
            title: UserGroupQuotaSubject
            allOf:
            - $ref: '#/components/schemas/UserGroupQuotaSubject'
    UserGroupQuotaPolicyPost:
      allOf:
      - $ref: '#/components/schemas/PolicyBase'
      - properties:
          rules:
            type: array
            maxItems: 2000
            items:
              $ref: '#/components/schemas/UserGroupQuotaPolicyRuleInPolicy'
            description: 'All of the rules that are part of this policy.

              '
    UserGroupQuotaPolicyRulePatch:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - properties:
          notifications:
            description: 'Specifies whether to send notifications to the affected quota subject or not.

              Valid values are `None` and `Account`.

              Defaults to `Account`.

              '
            type: string
          quota_limit:
            description: 'The limit of the quota (in bytes) for the specified user, cannot be `0`.

              If specified, this value will override the default quota for that particular subject type.

              '
            type: integer
            format: int64
    UserGroupQuotaPolicyRulesGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRulesResponse'
      - $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
    UserGroupQuotaPoliciesGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPoliciesResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _version:
      type: object
      properties:
        version:
          description: 'A hash of the other properties of this resource. This can be used when

            updating the resource to ensure there aren''t any updates since the

            resource was read.

            '
          type: string
          readOnly: true
    _policyRuleIndexInPolicy:
      type: object
      properties:
        index:
          description: 'The index within the policy. The `index` indicates the order the rules are evaluated.

            '
          type: integer
          format: int32
          readOnly: true
    _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/_fixedReference'
    _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'
        message:
          description: A description of the error which occurred.
          type: string
          example: Resource does not exist.
    _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: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
    _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
    PolicyMember:
      type: object
      properties:
        member:
          description: Reference to the resource the policy is applied to.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
        policy:
          description: Reference to the policy.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
    _fixedReference:
      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
    UserGroupQuotaPolicyRulePost:
      allOf:
      - properties:
          enforced:
            description: 'If set to `true`, this rule describes an enforced quota. A quota error

              is issued if the logical space usage of the subject exceeds the limit value

              described in this rule.

              '
            type: boolean
          notifications:
            description: 'Specifies whether to send notifications to the affected quota subject or not.

              Valid values are `None` and `Account`.

              Defaults to `Account`.

              '
            type: string
          quota_limit:
            description: 'The limit of the quota (in bytes) for the specified user, cannot be `0`.

              If specified, this value will override the default quota for that particular subject type.

              '
            type: integer
            format: int64
          quota_type:
            description: 'Specifies quota type for the quota policy. Valid values are `user`, `group`,

              `user-default`and `group-default`.

              `user-default` and `group-default` cannot be specified with a subject.

              '
            type: string
          subject:
            description: The user or group subject on which this rule is applied
            title: UserGroupQuotaSubject
            allOf:
            - $ref: '#/components/schemas/UserGroupQuotaSubject'
    PolicyMemberContext:
      allOf:
      - $ref: '#/components/schemas/PolicyMember'
      - $ref: '#/components/schemas/_context'
    PolicyBaseRenameable:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - $ref: '#/components/schemas/_realmsReference'
      - type: object
        properties:
          enabled:
            description: 'If `true`, the policy is enabled. If not specified, defaults to `true`.

              '
            type: boolean
          is_local:
            description: Whether the policy is defined on the local array.
            type: boolean
            readOnly: true
          location:
            description: Reference to the array where the policy is defined.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          policy_type:
            description: 'Type of the policy. Valid values include `alert`, `audit`, `bucket-access`,

              `cross-origin-resource-sharing`, `network-access`, `nfs`, `object-access`,

              `s3-export`, smb-client`, `smb-share`, `ssh-certificate-authority`, and

              `telemetry-metrics`.

              '
            type: string
            readOnly: true
    PolicyBase:
      allOf:
      - $ref: '#/components/schemas/PolicyBaseRenameable'
    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
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32
    UserGroupQuotaPolicyRule:
      allOf:
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRuleBase'
      - $ref: '#/components/schemas/_policyRuleIndex'
      - $ref: '#/components/schemas/_context'
    UserGroupQuotaSubject:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: UID/GID of the subject.
        name:
          type: string
          description: Name of the subject.
        sid:
          type: string
          description: SID of the subject.
    _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'
    UserGroupQuotaPolicyRulesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserGroupQuotaPolicyRule'
          description: 'Displays a list of all items after filtering.

            '
    UserGroupQuotaPoliciesMembersResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PolicyMemberContext'
          description: A list of members for user-group-quota policies.
    UserGroupQuotaPolicy:
      allOf:
      - $ref: '#/components/schemas/PolicyBaseRenameable'
      - $ref: '#/components/schemas/_version'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          rules:
            type: array
            maxItems: 2000
            items:
              $ref: '#/components/schemas/UserGroupQuotaPolicyRuleInPolicy'
            description: 'All of the rules that are part of this policy.

              '
    _policyRuleIndex:
      type: object
      properties:
        index:
          description: 'The index within the policy. The `index` indicates the order the rules are evaluated.

            NOTE: It is recommended to use the query param `before_rule_id` to do reordering to

            avoid concurrency issues, but changing `index` is also supported. `index` can not be

            changed if `before_rule_id` or `before_rule_name` are specified.

            '
          type: integer
          format: int32
    _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
    UserGroupQuotaPoliciesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserGroupQuotaPolicy'
          description: A list of user-group-quota policies.
    UserGroupQuotaPolicyRuleInPolicy:
      allOf:
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRuleBase'
      - $ref: '#/components/schemas/_policyRuleIndexInPolicy'
    UserGroupQuotaPoliciesMembersGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPoliciesMembersResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
  parameters:
    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
    File_system_names:
      name: file_system_names
      in: query
      description: 'A comma-separated list of file system names.

        If there is not at least one resource that matches

        each of the elements of `file_system_names`, then an error is returned.

        '
      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.

     

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-policies-user-and-group-quota-policy-api-openapi.yml