{
  "opencollection": "1.0.0",
  "info": {
    "name": "1Fort API Documentation Broker Groups API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "broker_groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Broker User Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              }
            ]
          },
          "docs": "\nList all broker user groups.\nReturns groups with member count for each group.\n"
        },
        {
          "info": {
            "name": "Create Broker User Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\nCreate a new broker user group.\n"
        },
        {
          "info": {
            "name": "List Group Memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:group_pk/members",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "group_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              }
            ]
          },
          "docs": "\nList all memberships for a specific broker user group.\n"
        },
        {
          "info": {
            "name": "Add User to Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:group_pk/members",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "group_pk",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\nAdd a broker user to a group.\nNote: Each user can only have one active group membership at a time.\n"
        },
        {
          "info": {
            "name": "Remove User from Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:group_pk/members/:id",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "group_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\nRemove a broker user from a group by deleting the membership.\n"
        },
        {
          "info": {
            "name": "Get Broker User Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:id",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\nGet detailed information about a specific broker user group.\n"
        },
        {
          "info": {
            "name": "Update Broker User Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:id",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\nUpdate a broker user group.\n"
        },
        {
          "info": {
            "name": "Partially Update Broker User Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:id",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\nPartially update a broker user group.\n"
        },
        {
          "info": {
            "name": "Delete Broker User Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.1fort.com/apis/broker/:broker_pk/groups/:id",
            "params": [
              {
                "name": "broker_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\nDelete a broker user group. Only groups without members can be deleted.\n"
        }
      ]
    }
  ],
  "bundled": true
}