{
  "opencollection": "1.0.0",
  "info": {
    "name": "ForgeRock Access Management Access Requests Groups API",
    "version": "7.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "iPlanetDirectoryPro",
      "value": "{{iPlanetDirectoryPro}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List directory groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{deployment}/am/api/groups",
            "params": [
              {
                "name": "_queryFilter",
                "value": "",
                "type": "query",
                "description": "CREST query filter expression, translated to an LDAP filter (e.g., uid eq \"jdoe\" becomes (uid=jdoe))"
              },
              {
                "name": "_pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              },
              {
                "name": "_pagedResultsCookie",
                "value": "",
                "type": "query",
                "description": "Cookie from a previous page for server-side paging"
              },
              {
                "name": "_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return"
              }
            ]
          },
          "docs": "Query group entries in the directory. Groups are mapped from LDAP groupOfUniqueNames or groupOfNames entries."
        },
        {
          "info": {
            "name": "Create a directory group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{deployment}/am/api/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new group entry in the directory."
        },
        {
          "info": {
            "name": "Get a directory group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{deployment}/am/api/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The group identifier (maps to LDAP cn)"
              },
              {
                "name": "_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return"
              }
            ]
          },
          "docs": "Retrieve a specific group entry by its identifier."
        },
        {
          "info": {
            "name": "Replace a directory group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{deployment}/am/api/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The group identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace an entire group entry."
        },
        {
          "info": {
            "name": "Patch a directory group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{deployment}/am/api/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The group identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Partially update a group entry. Commonly used to add or remove group members."
        },
        {
          "info": {
            "name": "Delete a directory group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{deployment}/am/api/groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The group identifier"
              }
            ]
          },
          "docs": "Delete a group entry from the directory."
        }
      ]
    }
  ],
  "bundled": true
}