{
  "opencollection": "1.0.0",
  "info": {
    "name": "SlashID Groups API",
    "version": "1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "SlashID-API-Key",
      "value": "{{SlashID-API-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get groups for a person",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.slashid.com/persons/:person_id/groups",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "person_id",
                "value": "903c1ff9-f2cc-435c-b242-9d8a690fcf0a",
                "type": "path",
                "description": "The person ID"
              }
            ]
          },
          "docs": "Retrieve the list of groups the specified person belongs to"
        },
        {
          "info": {
            "name": "Set the groups for a person",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.slashid.com/persons/:person_id/groups",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "person_id",
                "value": "903c1ff9-f2cc-435c-b242-9d8a690fcf0a",
                "type": "path",
                "description": "The person ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add the person to the groups specified in the request body, and remove the person from any other existing groups.\nAll groups in the request body must already exist. Duplicate groups in the request body will be ignored. If an empty list is supplied in the request body, the person will be removed from all groups they are currently a member of, and will not be added to any others.\nNew groups can be created with the [POST /groups](/docs/api/post-groups) endpoint.\n"
        },
        {
          "info": {
            "name": "Get a list of groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.slashid.com/groups",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ]
          },
          "docs": "List the names of all groups that exist for your organization"
        },
        {
          "info": {
            "name": "Create a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.slashid.com/groups",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              },
              {
                "name": "SlashID-Required-Consistency",
                "value": ""
              },
              {
                "name": "SlashID-Required-Consistency-Timeout",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint creates a new persons group with the given name.\n\nIf the group exists already, no action will be taken.\n\nThe group name must be unique within your organization; is case-sensitive; and must conform to the following:\n  - must be at least 2 characters long\n  - may be at most 100 characters long\n  - may contain only the characters `A-Z a-z 0-9 - _ .`\n  - must start and end with an alphanumeric character (`A-Z a-z 0-9`)\n\nA person can be added to a group through the [`POST /persons/:pers"
        },
        {
          "info": {
            "name": "Get a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.slashid.com/groups/:group_name",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "group_name",
                "value": "",
                "type": "path",
                "description": "The name of a group"
              }
            ]
          },
          "docs": "Get the named group"
        },
        {
          "info": {
            "name": "Delete a group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.slashid.com/groups/:group_name",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              },
              {
                "name": "SlashID-Required-Consistency",
                "value": ""
              },
              {
                "name": "SlashID-Required-Consistency-Timeout",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_name",
                "value": "",
                "type": "path",
                "description": "The name of a group"
              }
            ]
          },
          "docs": "Remove all persons from a group and permanently delete the group."
        },
        {
          "info": {
            "name": "List the persons in a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.slashid.com/groups/:group_name/persons",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "group_name",
                "value": "",
                "type": "path",
                "description": "The name of a group"
              }
            ]
          },
          "docs": "Lists all the persons in the named group. Returns an array of person IDs."
        },
        {
          "info": {
            "name": "Add persons to a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.slashid.com/groups/:group_name/persons",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "group_name",
                "value": "",
                "type": "path",
                "description": "The name of a group"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint adds one or more persons to an existing group. The group and all of the persons must exist. The persons to be added to the group must always be an array in the request body, even if only one user is being added. All persons needs to be in the same region.\nA new group can be created with the [POST /groups](/docs/api/post-groups) endpoint.\n"
        },
        {
          "info": {
            "name": "Delete a person from a group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.slashid.com/groups/:group_name/persons/:person_id",
            "headers": [
              {
                "name": "SlashID-OrgID",
                "value": "af5fbd30-7ce7-4548-8b30-4cd59cb2aba1"
              }
            ],
            "params": [
              {
                "name": "group_name",
                "value": "",
                "type": "path",
                "description": "The name of a group"
              },
              {
                "name": "person_id",
                "value": "903c1ff9-f2cc-435c-b242-9d8a690fcf0a",
                "type": "path",
                "description": "The person ID"
              }
            ]
          },
          "docs": "Removes the identified person from the named group. Returns an error if the person is not in the group.\n"
        }
      ]
    }
  ],
  "bundled": true
}