{
  "opencollection": "1.0.0",
  "info": {
    "name": "Drupal JSON: Comments Users API",
    "version": "1.1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/jsonapi/user/user",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filter[name][path]",
                "value": "",
                "type": "query",
                "description": "The dotted field path to filter on, e.g. title, status, uid.name, or field_tags.name for nested relationship fields."
              },
              {
                "name": "filter[name][value]",
                "value": "",
                "type": "query",
                "description": "The value to filter against."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the results by the given field. Prefix with - for descending order. For example, sort=title for ascending by title or sort=-created for descending by creation date."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of resources to return in a single page. Used for cursor-based pagination."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The number of resources to skip before beginning to return results. Used in combination with page[limit] for pagination."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of relationship paths to include in the response. For example, include=uid resolves the author relationship, and include=field_tags includes related taxonomy terms inline."
              },
              {
                "name": "fields[node--article]",
                "value": "",
                "type": "query",
                "description": "Sparse fieldset parameter to limit which attributes are returned, reducing response payload size. Replace node--article with the relevant resource type. Value is a comma-separated list of field names."
              }
            ]
          },
          "docs": "Retrieves a collection of user entities. Requires authentication and administer users permission to access. Supports filtering, sorting, pagination, sparse fieldsets, and includes."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/jsonapi/user/user/:uuid",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the entity. JSON:API always uses UUID as the identifier, not the numeric entity ID."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of relationship paths to include in the response. For example, include=uid resolves the author relationship, and include=field_tags includes related taxonomy terms inline."
              },
              {
                "name": "fields[node--article]",
                "value": "",
                "type": "query",
                "description": "Sparse fieldset parameter to limit which attributes are returned, reducing response payload size. Replace node--article with the relevant resource type. Value is a comma-separated list of field names."
              }
            ]
          },
          "docs": "Retrieves a single user entity by UUID. Users can read their own profile; administrators can read any user. Sensitive fields like email may be restricted to authenticated users with appropriate permissions."
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/jsonapi/user/user/:uuid",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the entity. JSON:API always uses UUID as the identifier, not the numeric entity ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing user entity by UUID. Users can update their own profiles; administrators can update any user account. Requires authentication."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/jsonapi/user/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the entity."
              }
            ]
          },
          "docs": "Retrieves a single user entity by its numeric ID. Returns the user's account fields and profile data. Anonymous users can retrieve basic information; additional fields require appropriate permissions."
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/jsonapi/user/:id",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the entity."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing user entity by its numeric ID. Only the fields included in the request body are modified. Users can update their own accounts; administrators can update any account. Requires authentication."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://example.com/jsonapi/user/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The numeric ID of the entity."
              }
            ]
          },
          "docs": "Permanently deletes a user account entity by its numeric ID. Only administrators with the appropriate permissions can delete user accounts. Requires authentication."
        }
      ]
    }
  ],
  "bundled": true
}