openapi: 3.0.1
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:
  parameters:
    Versions:
      name: versions
      in: query
      description: 'A comma-separated list of versions. This is an optional query param used for concurrency control.

        The ordering should match the names or ids query param.

        This will fail with a 412 Precondition failed if the resource was changed and the current

        version of the resource doesn''t match the value in the query param.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    File_system_ids:
      name: file_system_ids
      in: query
      description: 'A comma-separated list of file system IDs.

        If after filtering, there is not at least one resource that matches

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

        This cannot be provided together with the `file_system_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Allow_errors:
      name: allow_errors
      in: query
      description: 'If set to `true`, the API will allow the operation to continue even if there are errors.

        Any errors will be returned in the `errors` field of the response.

        If set to `false`, the operation will fail if there are any errors.

        '
      schema:
        type: boolean
        default: false
    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
    Policy_ids:
      name: policy_ids
      in: query
      description: 'A comma-separated list of policy IDs.

        If after filtering, there is not at least one resource that matches

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

        This cannot be provided together with the `policy_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Continuation_token:
      name: continuation_token
      in: query
      description: 'A token used to retrieve the next page of data

        with some consistency guaranteed.

        The token is a Base64 encoded value.

        Set `continuation_token` to the system-generated token taken from the `x-next-token`

        header field of the response.

        A query has reached its last page when the response does not include a token.

        Pagination requires the `limit` and `continuation_token`

        query parameters.

        '
      schema:
        type: string
    Policy_names:
      name: policy_names
      in: query
      description: 'A comma-separated list of policy names.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Context_names:
      name: context_names
      in: query
      description: 'Performs the operation on the context specified.


        If specified, the context names must be an array of size 1, and the single element

        must be the name of an array in the same fleet or the name of the fleet itself. If

        not specified, the context will default to the array that received this request.


        Other parameters provided with the request, such as names of volumes or snapshots,

        are resolved relative to the provided `context`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Names_required:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        '
      required: true
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: 'Limits the size of the response to the specified number of objects on each page.

        To return the total number of resources, set `limit=0`.

        The total number of resources is returned as a `total_item_count` value.

        If the page size requested is larger than the system maximum limit,

        the server returns the maximum limit, disregarding the requested page size.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Names:
      name: names
      in: query
      description: 'Performs the operation on the unique names specified.

        Enter multiple names in comma-separated format.

        For example, `name01,name02`.


        If there is not at least one resource that matches

        each of the elements of `names`, then an error is returned,

        except when creating new resources.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Delete_existing_user_group_quota_settings:
      name: delete_existing_user_group_quota_settings
      in: query
      description: 'This parameter must be set to `true` in order to delete

        existing quota configurations(default_group_quota, default_user_quota or specific quotas) set

        on a file system using either using `quotas/users`, `quotas/groups` or

        `/file-systems`. Setting this parameter to `true` is acknowledgement

        that the currently configured quotas would be erased before attaching the policy.

        Defaults to `false`.

        '
      schema:
        type: boolean
    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
    Ignore_usage_user_group_quotas:
      name: ignore_usage
      in: query
      description: 'Flag used to override checks for user-group-quota management operations.

        If set to `true`, user/group usage is not checked against the `quota_limits` of

        user-group-quota rules.

        '
      schema:
        type: boolean
    Member_ids:
      name: member_ids
      in: query
      description: 'A comma-separated list of member IDs.

        If after filtering, there is not at least one resource that matches

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

        This cannot be provided together with the `member_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Member_names:
      name: member_names
      in: query
      description: 'A comma-separated list of member names.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Ids:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If after filtering, there is not at least one resource that matches

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

        This cannot be provided together with the `name` or `names` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Sort:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        NOTE: If you provide a sort you will not get a `continuation_token` in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
  schemas:
    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'
    _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.
    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.

              '
    _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'
    PolicyBase:
      allOf:
      - $ref: '#/components/schemas/PolicyBaseRenameable'
    _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
    _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
    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.
    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'
    UserGroupQuotaPoliciesMembersGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPoliciesMembersResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    UserGroupQuotaPoliciesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserGroupQuotaPolicy'
          description: A list of user-group-quota policies.
    UserGroupQuotaPoliciesGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPoliciesResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    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.

              '
    UserGroupQuotaPolicyRulesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserGroupQuotaPolicyRule'
          description: 'Displays a list of all items after filtering.

            '
    UserGroupQuotaPolicyRuleInPolicy:
      allOf:
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRuleBase'
      - $ref: '#/components/schemas/_policyRuleIndexInPolicy'
    _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
    UserGroupQuotaPolicyRule:
      allOf:
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRuleBase'
      - $ref: '#/components/schemas/_policyRuleIndex'
      - $ref: '#/components/schemas/_context'
    UserGroupQuotaPoliciesMembersResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PolicyMemberContext'
          description: A list of members for user-group-quota policies.
    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'
    _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'
    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
    _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
    UserGroupQuotaPolicyRulesGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/UserGroupQuotaPolicyRulesResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    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
    _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
    _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'
    _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
    _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
    PolicyMemberContext:
      allOf:
      - $ref: '#/components/schemas/PolicyMember'
      - $ref: '#/components/schemas/_context'
    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