{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ironclad OAuth 2.0 Authorization Groups API",
    "version": "1"
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://na1.ironcladapp.com/oauth/Groups",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "startIndex",
                "value": "",
                "type": "query",
                "description": "The starting index for retrieving this resource. Resources are indexed based on when they were first added to Ironclad."
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of resources to return in a single page of results."
              },
              {
                "name": "filter",
                "value": "displayName eq \"Legal Ops Group\"",
                "type": "query",
                "description": "Filters for identifying subsets of groups. Filters must comply with the SCIM protocol's convention. For more details, see SCIM [RFC 7644 Section 3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2)."
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to exclude from the resources in the response."
              }
            ]
          },
          "docs": "Documentation on listing Groups via SCIM. \n\n**OAuth Scope required:** `scim.groups.readGroups`"
        },
        {
          "info": {
            "name": "Create a Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://na1.ironcladapp.com/oauth/Groups",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to exclude from the resources in the response."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Documentation on creating a Group via SCIM. \n\n**OAuth Scope required:** `scim.groups.createGroups`"
        },
        {
          "info": {
            "name": "Retrieve a Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://na1.ironcladapp.com/oauth/Groups/:groupId",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter"
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to exclude from the resources in the response."
              }
            ]
          },
          "docs": "Documentation on accessing a Group via SCIM. \n\n**OAuth Scope required:** `scim.groups.readGroups`"
        },
        {
          "info": {
            "name": "Replace a Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://na1.ironcladapp.com/oauth/Groups/:groupId",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter"
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to exclude from the resources in the response."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Documentation on replacing a Group via SCIM. \n\n**OAuth Scope required:** `scim.groups.updateGroups`"
        },
        {
          "info": {
            "name": "Update a Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://na1.ironcladapp.com/oauth/Groups/:groupId",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter"
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to exclude from the resources in the response."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Documentation on updating a Group via SCIM. This includes updating group membership. \n\n**OAuth Scope required:** `scim.groups.updateGroups`"
        },
        {
          "info": {
            "name": "Delete a Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://na1.ironcladapp.com/oauth/Groups/:groupId",
            "headers": [
              {
                "name": "x-as-user-email",
                "value": ""
              },
              {
                "name": "x-as-user-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter"
              }
            ]
          },
          "docs": "Documentation on deleting a Group via SCIM. \n\n**OAuth Scope required:** `scim.groups.deleteGroups`"
        }
      ]
    }
  ],
  "bundled": true
}